List Roles

get https://app.mk.io/api/v1/organization/roles

Returns details of all Roles.

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

200 A list of all roles
kindstringRequired
The kind of record.
valuelist of objectsRoleGetSchemaRequired
List of roles.
Show 3 propertiesHide 3 properties
kindstringOptional
The kind of record.
metadataobjectRoleMetadataSchemaRequired
Role metadata.
Show 3 propertiesHide 3 properties
categorieslist of stringsRequired
Some capabilities apply to resources at the organization level, some apply only at the project level. This list suggests which categories of scope this role should be combined with.
idstringRequiredformat: uuid
The ID of the resource
namestringOptional
The name of the resource
specobjectRoleSpecSchemaRequired
Role specification.
Show 2 propertiesHide 2 properties
capabilitieslist of objectsRoleCapabilitySchemaOptional
List of capabilities.
Show 1 propertyHide 1 property
capabilitystringRequired
The name of the capability.
descriptionstringRequired0-256 characters
A description of the role.

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code