Get roles.

Get roles.

Get roles.

Query Parameters

sort string[]
query string
perPage integer

Default value: 100

page integer

Default value: 1

kind string
extract string[]

Responses

• 200
• 400
• 401
• 403
• 404
• 408
• 409
• 415
• 422
• 429
• 500
• 503
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

items object[]
Array [
applicableEnvironmentTypes string[]
builtin boolean
createTime date-time
description string
id string
kind string
policies object[]
Array [
actions string[]
paths string[]
resourceRefers string[]
resources string[]
]
updateTime date-time
]
pagination object
nextPage integer
page integer
partial integer
perPage integer
total integer
totalPage integer
type string

{
  "items": [
    {
      "applicableEnvironmentTypes": [
        "string"
      ],
      "builtin": true,
      "createTime": "2024-03-21T10:37:39.525Z",
      "description": "string",
      "id": "string",
      "kind": "string",
      "policies": [
        {
          "actions": [
            "string"
          ],
          "paths": [
            "string"
          ],
          "resourceRefers": [
            "string"
          ],
          "resources": [
            "string"
          ]
        }
      ],
      "updateTime": "2024-03-21T10:37:39.525Z"
    }
  ],
  "pagination": {
    "nextPage": 0,
    "page": 0,
    "partial": 0,
    "perPage": 0,
    "total": 0,
    "totalPage": 0
  },
  "type": "string"
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 400

statusText string

Default value: Bad Request

{
  "message": "string",
  "status": 400,
  "statusText": "Bad Request"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 401

statusText string

Default value: Unauthorized

{
  "message": "string",
  "status": 401,
  "statusText": "Unauthorized"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 403

statusText string

Default value: Forbidden

{
  "message": "string",
  "status": 403,
  "statusText": "Forbidden"
}

Not Found

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 404

statusText string

Default value: Not Found

{
  "message": "string",
  "status": 404,
  "statusText": "Not Found"
}

Request Timeout

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 408

statusText string

Default value: Request Timeout

{
  "message": "string",
  "status": 408,
  "statusText": "Request Timeout"
}

Conflict

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 409

statusText string

Default value: Conflict

{
  "message": "string",
  "status": 409,
  "statusText": "Conflict"
}

Unsupported Media Type

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 415

statusText string

Default value: Unsupported Media Type

{
  "message": "string",
  "status": 415,
  "statusText": "Unsupported Media Type"
}

Unprocessable Entity

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 422

statusText string

Default value: Unprocessable Entity

{
  "message": "string",
  "status": 422,
  "statusText": "Unprocessable Entity"
}

Too Many Requests

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 429

statusText string

Default value: Too Many Requests

{
  "message": "string",
  "status": 429,
  "statusText": "Too Many Requests"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 500

statusText string

Default value: Internal Server Error

{
  "message": "string",
  "status": 500,
  "statusText": "Internal Server Error"
}

Service Unavailable

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 503

statusText string

Default value: Service Unavailable

{
  "message": "string",
  "status": 503,
  "statusText": "Service Unavailable"
}

Loading...