A role is a group of permissions that can be granted. Permissions are a set of actions that can be applied to entities. For more information, see Roles.
Get a list of roles.
Use to retrieve a list of roles.
SecuritybearerAuth
Responses
200
Executed successfully.
400
Bad request.
401
Unauthorized
403
Forbidden
500
unexpected error
503
unexpected error
get/api/v1/authorization/roles
Response samples
- 200
- 400
- 401
- 403
- 500
- 503
application/json
[- {
- "name": "admin",
- "description": "can manage all resources",
- "permissions": [
- {
- "resourceType": "department",
- "displayName": "Projects",
- "groupId": "organization",
- "actions": [
- "create"
]
}
], - "type": "system",
- "tenantId": "string",
- "enabled": true,
- "kubernetesPermissions": {
- "predefinedRole": "12"
}, - "id": 32,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "createdBy": "user@run.ai",
- "custom": true,
- "effectiveEnabled": true
}
]Get a role by id.
Retrieve the details of a role by id.
SecuritybearerAuth
Request
Responses
200
Executed successfully.
400
Bad request.
401
Unauthorized
403
Forbidden
404
The specified resource was not found
500
unexpected error
503
unexpected error
get/api/v1/authorization/roles/{roleIdPath}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
application/json
{- "name": "admin",
- "description": "can manage all resources",
- "permissions": [
- {
- "resourceType": "department",
- "displayName": "Projects",
- "groupId": "organization",
- "actions": [
- "create"
]
}
], - "type": "system",
- "tenantId": "string",
- "enabled": true,
- "kubernetesPermissions": {
- "predefinedRole": "12"
}, - "id": 32,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "createdBy": "user@run.ai",
- "custom": true,
- "effectiveEnabled": true
}