GET User Roles¶
Gets all the logical roles belonging to the current user.
HTTP Method: GET
URL: https://<mobile services host>/mobileservices/application/{appId}/roleservice/application/{appId}/v2/Me
Request Parameters¶
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
appId |
Required | The current application to use the role service. | string |
Response Parameters¶
| Parameter | Type | Description | Parameter Type |
|---|---|---|---|
id |
Mandatory | The user's ID if included in SAML or OAuth authentication. | string |
userName |
Mandatory | The user's user name if included in SAML or OAuth authentication. | string |
roles |
Optional | The user's role if included in SAML or OAuth authentication. | string |
others |
Optional | Additional information if included in SAML or OAuth authentication. | string |
detail |
Optional | Additional information if included. | string |
familyName |
Optional | The user's family name. The name is filled in using fuzzy matching (for example, familyName or familyname attributes would match, as well as the family_name SAML attribute). |
string |
givenName |
Optional | The user's given name. The name is filled in using fuzzy matching (for example, givenName or givenname attributes would match, as well as the given_name SAML attribute). |
string |
emails |
Optional | The user's email address if the email attribute is included in SAML or OAuth authentication. |
string |
registrationId |
Optional | The device's registration ID, if the device has onboarded to mobile services. | string |
Response Status and Error Codes¶
| Code | Description |
|---|---|
| 200 | Retrieval of the roles associated with the user is successful. |
| 403 | The user does not have the required authorization to access this application. |
| 404 | Application ID does not exist. |
| 412 | The application is not enabled for access control. |
Last update: January 28, 2025