List oauth roles

GET 
/api/web/v1/oauthroles

List all oauth roles. Caller requires the OAUTHROLES:VIEW permission.

Responses

200

Successful

application/json

Schema

Schema

• Array [

ancestorIds string[]required

The set of ancestor oauth role ids.

descendantIds string[]required

The set of descendant oauth role ids.

description string

The description of this oauth role.

id stringrequired

The UUID of this oauth role. This value is generated when the oauth role is created.

inheritedResourceServerScopeIds string[]required

The set of resource server scopes ids associated with this oauth role based on inheritance from its ancestors.

name stringrequired

The name of this oauth role.

parentId string

The UUID of the parent of this oauth role, if one exists.

resourceServerScopeIds string[]required

The set of resource server scopes ids associated with this oauth role.

• ]

Example (from schema)

[
  {
    "ancestorIds": [
      "string"
    ],
    "descendantIds": [
      "string"
    ],
    "description": "string",
    "id": "string",
    "inheritedResourceServerScopeIds": [
      "string"
    ],
    "name": "string",
    "parentId": "string",
    "resourceServerScopeIds": [
      "string"
    ]
  }
]

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...