List Roles

Request

URI

GET

https://http://localhost:3000/api/roles

COPY

Path Parameters

integer

page.number

Optional

page number.

integer

page.size

Optional

page size.

string

page.sort

Optional

page.sort

string

query_type

Optional

QueryType decides the roles should be retrieved for currentOrg or its descendants or ancestors If query type is not set and when OrgHierachy is enabled by default roles at currentOrg and its all descendant levels are retrieved. If query type is not set and when OrgHierachy is disabled by default roles at currentOrg level are retrieved.

SHOW_CURRENT: If set will retrieve entities only from current org level

Responses

200

Returns iamListRolesResponse of type(s) */*

{
    "pageInfo": {
        "totalPages": "string",
        "totalElements": "string",
        "page": "integer",
        "pageSize": "integer"
    },
    "roles": [
        {
            "lastUpdatedTime": "string",
            "name": "string",
            "lastUpdatedBy": "string",
            "updateVersion": "integer",
            "createdBy": "string",
            "createdTime": "string",
            "orgId": "string",
            "permissions": [
                {
                    "permissionNumber": "integer",
                    "name": "string",
                    "description": "string"
                }
            ],
            "id": "string",
            "description": "string"
        }
    ]
}

commonPageResponse

pageInfo

Optional

pageInfo

array of iamRole

roles

Optional

roles

404

Not Found

Operation doesn't return any data structure

On This Page