Skip to main content

Check Access

Check if a user or account is supposed to have access to a particular entitlement, if there are change requests related to the entitlement and if the entitlement violates a policy.

GET https://instance.securid.com/aveksa/command.submit?cmd=about

Request​

Parameters​

Common
checkAccess
format

properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.

json - Useful format for parsing into javascript or other languages. See www.json.org for details.

checkOptionIndicates to check access or validate access grants.
  • checkAccess (default)
  • validateRuleOnly
  • validateCROnly
  • validateCRAndRule
ignoreUserMappingtrue, false Boolean flag to ignore checking of access for users mapped to the specified account. (Default) false
Accounts
accountBSThis specifies the name of the business source, such as an application or directory, associated with the account. It should be used in conjunction with the accountName parameter
accountNameThe account name and must be used along with accountName parameter
userIdUser id or login id
uniqueIdUser unique id
emailUser email address
Entitlements
entitlementBSThe application, directory, or role set name for the entitlement
appRoleApplication role name
resourceThe name of the entitlement resource, which must be used in conjunction with the action parameter
roleRole name
groupGroup name

Response​

Parameters​

typeExecuted command name
resultThe user or account has access to the entitlement, or if access grant is permitted true, or not false
crStateallowed / denied / notCheckCR
violationsReturns the names of rules if there are any rule violations; otherwise, indicates noViolations

Errors​

400If the user / account / business source / entitlement cannot be found, an error message will be returned in the response body

Examples​

Request​

curl -X GET -G "https://instance.securid.com/aveksa/command.submit" \
-d "cmd=checkAccess" \
-d "userId=my_account_id" \
-d "format=json" \
-d "entitlementBS=Aveksa" \
-d "appRole=System%20Administrator" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Response​

{
    "data": {
        "type": "checkAccess",
        "result": "true"
    }
}
Last updated on