Get site role assigned to user
GET/api/web/v1/users/:userid/roles/:roleid
Get the specified site role assigned to the specified user. Caller requires the USERSITEROLES:VIEW permission.
Request
Path Parameters
The UUID of the user to which the role is assigned.
The UUID of the role assigned to the user.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
A flag indicating if administrators with this role can manage all roles and all users.
A flag indicating if this role is one of the default roles.
The description of the role.
The UUIDs of groups associated with this role when Group Management is DEFINED. This attribute is ignored if Group Management is ALL or OWN.
Possible values: [ALL
, DEFINED
, OWN
]
The type of the group management. Defaults to ALL if not provided.
The UUID of the role.
If allRoles is false, this attribute lists the roles and administrators in these roles thatcan be administered by administrators with this role. Administrators will also be able to manage end users.
The name of the role.
permissions
object[]
A list of the permissions assigned to this role.
Possible values: [VIEW
, ADD
, EDIT
, REMOVE
, ALL
]
The action to which this permission applies.
Possible values: [ALL
, SUBSCRIBERS
, USERS
, APPLICATIONS
, TOKENS
, ROLES
, SPROLES
, CONTEXTRULES
, AUTHORIZATIONGROUPS
, USERATTRIBUTES
, USERATTRIBUTEVALUES
, AGENTS
, GROUPS
, SETTINGS
, DIRECTORIES
, DIRECTORYSYNC
, DIRECTORYCONNECTIONS
, TEMPLATES
, USERSITEROLES
, REPORTS
, BULKUSERS
, BULKGROUPS
, USERPASSWORDS
, SERVICEPROVIDERS
, SERVICEPROVIDERACCOUNTS
, USERMACHINES
, CAS
, BULKHARDWARETOKENS
, BULKSMARTCARDS
, DIGITALIDCONFIGS
, DIGITALIDCONFIGVARIABLES
, DIGITALIDCONFIGCERTTEMPS
, DIGITALIDCONFIGSANS
, SCDEFNS
, SCDEFNPIVAPPLETCONFIGS
, SCDEFNVARIABLES
, SMARTCREDENTIALS
, SMARTCREDENTIALSSIGNATURE
, USERSPROLES
, EXPECTEDLOCATIONS
, USERLOCATIONS
, USERRBASETTINGS
, SPCLIENTCREDENTIALS
, SPMANAGEMENTPLATFORM
, ENTITLEMENTS
, QUESTIONS
, USERQUESTIONS
, USERQUESTIONANSWERS
, USERKBACHALLENGES
, WORDSYNONYMS
, GATEWAYS
, GATEWAYCSRS
, SPUSERMGMT
, BULKIDENTITYGUARD
, TEMPACCESSCODES
, TEMPACCESSCODECONTENTS
, GRIDS
, GRIDCONTENTS
, FIDOTOKENS
, EXPORTREPORTS
, CUSTOMIZATIONVARIABLES
, BLACKLISTEDPASSWORDS
, SPENTITLEMENTS
, CREATETENANT
, TENANTS
, ARCHIVES
, CERTIFICATES
, INTELLITRUSTDESKTOPS
, ACTIVESYNC
, PRINTERS
, ISSUANCE
, IDPROOFING
, IDPROOFINGLICENSE
, OTPS
, AD_CONNECTOR_DIRECTORIES
, AZURE_DIRECTORIES
, SCHEDULEDTASKS
, CREDENTIALDESIGNS
, ENROLLMENTS
, BULKENROLLMENTS
, EMAILTEMPLATES
, EMAILVARIABLES
, SENDEMAIL
, SENDSCIM
, SENDAZUREAD
, DIRECTORYPASSWORD
, TRANSACTIONITEMS
, TRANSACTIONRULES
, ENROLLMENTDESIGNS
, HIGH_AVAILABILITY_GROUPS
, PKIAASCREDENTIALS
, DIGITALIDCERTIFICATES
, PIVCONTENTSIGNER
, RESOURCESERVERAPIS
, RESOURCESERVERSCOPES
, USEROAUTHTOKENS
, GROUPPOLICIES
, OAUTHROLES
, IDENTITYPROVIDERS
, SMARTCARDS
, IPLISTS
, DOMAINCONTROLLERCERTS
, OTPPROVIDERS
, PREFERREDOTPPROVIDERS
, SPIDENTITYPROVIDERS
, PUSHCREDENTIALS
, DIRECTORYSEARCHATTRIBUTES
, DIRECTORYATTRIBUTES
, RISKENGINES
, SCIMPROVISIONINGS
, RATELIMITING
, CLAIMS
, CONTACTVERIFICATION
, HOSTNAMESETTINGS
, MAGICLINKS
, MAGICLINKCONTENTS
, AUTHENTICATIONFLOWS
, FACE
, TOKENACTIVATIONCONTENTS
, POLICYOVERRIDE
, ORGANIZATIONS
]
The entity to which this permission applies.
The UUID of this permission.
Possible values: [SITE_ADMINISTRATOR
, ACCOUNT_MANAGER
]
The role type to which this permission applies.
Possible values: [SITE_ADMINISTRATOR
, ACCOUNT_MANAGER
]
The type of the role.
A flag indicating if this role is a super administrator.
{
"allRoles": true,
"defaultRole": true,
"description": "string",
"groupIds": [
"string"
],
"groupManagement": "ALL",
"id": "string",
"managedRoles": [
null
],
"name": "string",
"permissions": [
{
"actionType": "VIEW",
"entityType": "ALL",
"id": "string",
"roleType": "SITE_ADMINISTRATOR"
}
],
"roleType": "SITE_ADMINISTRATOR",
"superAdministrator": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}