Get a Built-in Role

GET 
/v2/permissions/built-in-roles/:built_in_role_id

Get a Built-in Role

Request

Path Parameters

built_in_role_id stringrequired
The ID of the Built-In Role.
Example: f5f77dd6-71df-48a4-b4f4-d2605a79f3ca

Responses

200

OK

application/json

Schema

Schema

data object

id uuid

The unique identifier for the Built-in Role.

type string

Specifies the type of the resource object, use built_in_role for Built-in Roles.

name string

Specifies the name of the Built-in Role.

cm_user_assignable boolean

Specifies if the Built-in Role can be assigned to a user in Commerce Manager.

links object

self uri

Specifies the URI of the Built-In Role.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "name": "string",
    "cm_user_assignable": true,
    "links": {
      "self": "/v2/permissions/built-in-roles/f5f77dd6-71df-48a4-b4f4-d2605a79f3ca"
    }
  }
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

not-found

Requested entity not found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "Not found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...