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

• kind string Required
  The kind of record.
• value list of objects RoleGetSchema Required
  List of roles.

Show 3 properties Hide 3 properties

• kind string Optional
  The kind of record.
• metadata object RoleMetadataSchema Required
  Role metadata.

Show 3 properties Hide 3 properties

• categories list of strings Required
  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.
• id string Required format: uuid
  The ID of the resource
• name string Optional
  The name of the resource
• spec object RoleSpecSchema Required
  Role specification.

Show 2 properties Hide 2 properties

• capabilities list of objects RoleCapabilitySchema Optional
  List of capabilities.

Show 1 property Hide 1 property

• capability string Required
  The name of the capability.
• description string Required 0-256 characters
  A description of the role.

Errors

• 400 Bad Request

  • error object ErrorDetail Required
    Pertinent information about the error
    • code string Required
      The error code.
    • detail string Required
      The error message.
    • extraDetail map from strings to any Optional
      Extra information regarding this error.
    • ref string Required
      A reference to the request that caused the error.
    • status integer Required
      The HTTP status code

• 401 Unauthorized

  • error object ErrorDetail Required
    Pertinent information about the error
    • code string Required
      The error code.
    • detail string Required
      The error message.
    • extraDetail map from strings to any Optional
      Extra information regarding this error.
    • ref string Required
      A reference to the request that caused the error.
    • status integer Required
      The HTTP status code

• 403 Forbidden

  • error object ErrorDetail Required
    Pertinent information about the error
    • code string Required
      The error code.
    • detail string Required
      The error message.
    • extraDetail map from strings to any Optional
      Extra information regarding this error.
    • ref string Required
      A reference to the request that caused the error.
    • status integer Required
      The HTTP status code

• 404 Not Found

  • error object ErrorDetail Required
    Pertinent information about the error
    • code string Required
      The error code.
    • detail string Required
      The error message.
    • extraDetail map from strings to any Optional
      Extra information regarding this error.
    • ref string Required
      A reference to the request that caused the error.
    • status integer Required
      The HTTP status code

• 429 Too Many Requests

  • error object ErrorDetail Required
    Pertinent information about the error
    • code string Required
      The error code.
    • detail string Required
      The error message.
    • extraDetail map from strings to any Optional
      Extra information regarding this error.
    • ref string Required
      A reference to the request that caused the error.
    • status integer Required
      The HTTP status code

• 500 Internal Server Error

  • error object ErrorDetail Required
    Pertinent information about the error
    • code string Required
      The error code.
    • detail string Required
      The error message.
    • extraDetail map from strings to any Optional
      Extra information regarding this error.
    • ref string Required
      A reference to the request that caused the error.
    • status integer Required
      The HTTP status code