Jump to

• Request
• Response

Get Application Roles

get

/cloudapi/restapi/v3/roles

This end point returns application roles. It includes roles of all the products available for the respective environment.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RoleRO
  Title: RoleRO

  Application role assigned to a user or company.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RoleRO"
    }
}

Nested Schema : RoleRO

Type: object

Title: RoleRO

Application role assigned to a user or company.

Show Source

• companyAccessType: boolean
  Title: companyAccessType

  Indicates whether the role grants company-level access.
• displayName: string
  Title: displayName

  Display name for the role.
• id: string
  Title: id

  Read Only: true

  Internal role identifier.
• name(required): string
  Title: name

  Role name.
• userAccessType: string
  Title: userAccessType

  User access type granted by the role.

{
    "title":"RoleRO",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"name",
            "type":"string",
            "description":"Role name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal role identifier.",
            "readOnly":true
        },
        "displayName":{
            "title":"displayName",
            "type":"string",
            "description":"Display name for the role."
        },
        "userAccessType":{
            "title":"userAccessType",
            "type":"string",
            "description":"User access type granted by the role."
        },
        "companyAccessType":{
            "title":"companyAccessType",
            "type":"boolean",
            "description":"Indicates whether the role grants company-level access."
        }
    },
    "description":"Application role assigned to a user or company.",
    "xml":{
        "name":"Role"
    }
}

400 Response

Invalid input, Please re-check the input.

Back to Top