Jump to

• Request
• Response

List Roles

get

/process/api/v1/data-access/roles

List all the roles in a paginated format.

Request

Query Parameters

• limit: integer(int32)
  The numbers of items to return. If parameter is omitted, the default value 25 is set.

  Examples

  Select an example default value

• offset: integer(int64)
  The number of items to skip before starting to collect the result set.

  Examples

  Select an example Default offset value Skip first 10 elements

• orderBy: string
  This query parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*.

  Examples

  Select an example ascending order descending order complex order

• q: string
  This query parameter specifies the filter used to restrict which role object should be returned in a PageableResponse. It defines a filter based on SCIM filtering notation. The filter supports the following fields in expressions: name, description, scopeType, scopeName and createdOn (given in ISO 8601 format). The filter supports expression operators: eq,ne,co,sw,ew,pr,gt,ge,lt,le. It also supports logical operators OR and AND. Boolean expressions may be grouped using parentheses to change the standard order of operations; i.e., evaluate OR logical operators before logical AND operators. For example, ?q=(name sw "Role" or (scopeName eq "Application1" and description co "Process" )).

  Examples

  Select an example equals startWith contains less then complex expression

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PageableRoleResponse

Type: object

Title: PageableRoleResponse

Defines PageableRoleResponse

Show Source

• items: array items
  Title: items
• totalPages: integer
• totalResults: integer

{
    "title":"PageableRoleResponse",
    "description":"Defines PageableRoleResponse",
    "additionalProperties":false,
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        },
        "totalPages":{
            "type":"integer"
        },
        "items":{
            "title":"items",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            }
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

• Array of: object Role
  Title: Role

  Defines Role

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

Nested Schema : Role

Type: object

Title: Role

Defines Role

Show Source

• createdOn: string
  Title: Created time

  Created time
• description: string
  Title: The role description

  Tho role description
• id: string
  Title: The role ID

  The unique role ID
• links: array links
• name(required): string
  Title: The role name

  The unique role name
• scopeName: string
  Title: Scope Name

  The role scope name
• scopeType: string
  Title: Scope Type

  The role scope type
• systemDefined: boolean
  Title: System Defined Role

  Default Value: false

  If boolean flag is true, then the Role cannot be deleted. By default it's false.
• updatedOn: string
  Title: Updated time

  Updated time

{
    "type":"object",
    "title":"Role",
    "description":"Defines Role",
    "additionalProperties":false,
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "title":"The role ID",
            "description":"The unique role ID"
        },
        "name":{
            "type":"string",
            "title":"The role name",
            "description":"The unique role name"
        },
        "description":{
            "type":"string",
            "title":"The role description",
            "description":"Tho role description"
        },
        "scopeType":{
            "type":"string",
            "title":"Scope Type",
            "description":"The role scope type"
        },
        "scopeName":{
            "type":"string",
            "title":"Scope Name",
            "description":"The role scope name"
        },
        "systemDefined":{
            "type":"boolean",
            "default":false,
            "title":"System Defined Role",
            "description":"If boolean flag is true, then the Role cannot be deleted. By default it's false."
        },
        "createdOn":{
            "type":"string",
            "title":"Created time",
            "description":"Created time"
        },
        "updatedOn":{
            "type":"string",
            "title":"Updated time",
            "description":"Updated time"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

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

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example error

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

429 Response

Too many requests

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

503 Response

Too many exceptions or too slow requests

Back to Top