Get Supported Roles

GET /roles

This API retrieves all supported roles.

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- type string
  
  The role type.
- value string
  
  The role name.
- adminRoles array[string]
  
  List of available admin roles.
401 application/json

Authentication Error. Invalid credentials.
Hide response attributes Show response attributes object
- code string
- message string
- description string
403

Authorization Error. Invalid role for request.

GET /roles

curl \
 --request GET 'https://localhost:8080/roles' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "type": "Close",
    "value": "Admin"
  },
  {
    "type": "Certification",
    "value": "Approver"
  },
  {
    "type": "Certification",
    "value": "ProgramAdmin",
    "adminRoles": [
      "AdminRole1",
      "AdminRole2",
      "AdminRole3"
    ]
  },
  {
    "type": "JournalEntry",
    "value": "Approver"
  }
]

Response examples (401)

{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}