Gets roles assigned to the user

Gets the roles assigned to the user.

get

Path parameters

userIdstringRequired

The id of the user.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

403

The user's access was denied.

application/json

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/{userId}/roles

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId}/roles HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "parentBrandId": null,
      "guid": "08b0c895-7cee-4f42-aadd-a4f207bd09dd",
      "code": "EXAMPLE",
      "name": "Example",
      "description": "Description",
      "tags": "#Example",
      "type": "Custom",
      "permissions": [
        "Resource.Action"
      ]
    }
  ],
  "errors": []
}