Get a Scope

get https://app.mk.io/api/v1/organization/scopes/:scope_name

Returns details of a single Scope.

RBAC Capability Required: core.scope.get

Authentication

Authorization Bearer

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

Path parameters

• scope_name string Required

Response

• 200 The scope
  • kind string Optional
    The kind of record.
  • metadata object ScopeMetadataSchema Required
    • Show 2 properties
      • id string Required format: uuid
        The ID of the resource
      • name string Optional
        The name of the resource
  • spec object ScopeSpecSchema Required
    • Show 2 properties
      • description string Required 0-256 characters
        A description of the scope.
      • resources list of objects ScopeResourceSchema Optional
        List of resources.
      • Show 2 properties
        • id string Required format: uuid
          The id of the resource.
        • type string Required
          The type of the resource.

Errors

• 400 Bad Request
  • error object ErrorDetail Required
    • Show 3 properties
      • code string Required
        The error code.
      • detail string Required
        The error message.
      • extraDetail map from strings to any Optional
        Extra information regarding this error.
        • Show value schema
          • [any key] any
      • 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
    • Show 3 properties
      • code string Required
        The error code.
      • detail string Required
        The error message.
      • extraDetail map from strings to any Optional
        Extra information regarding this error.
        • Show value schema
          • [any key] any
      • 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
    • Show 3 properties
      • code string Required
        The error code.
      • detail string Required
        The error message.
      • extraDetail map from strings to any Optional
        Extra information regarding this error.
        • Show value schema
          • [any key] any
      • 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
    • Show 3 properties
      • code string Required
        The error code.
      • detail string Required
        The error message.
      • extraDetail map from strings to any Optional
        Extra information regarding this error.
        • Show value schema
          • [any key] any
      • 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
    • Show 3 properties
      • code string Required
        The error code.
      • detail string Required
        The error message.
      • extraDetail map from strings to any Optional
        Extra information regarding this error.
        • Show value schema
          • [any key] any
      • 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
    • Show 3 properties
      • code string Required
        The error code.
      • detail string Required
        The error message.
      • extraDetail map from strings to any Optional
        Extra information regarding this error.
        • Show value schema
          • [any key] any
      • ref string Required
        A reference to the request that caused the error.
      • status integer Required
        The HTTP status code