Get a Built-in Role

GET 
https://useast.api.elasticpath.com/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
iduuid
The unique identifier for the Built-in Role.
typestring
Specifies the type of the resource object, use built_in_role for Built-in Roles.
namestring
Specifies the name of the Built-in Role.
cm_user_assignableboolean
Specifies if the Built-in Role can be assigned to a user in Commerce Manager.
links object
selfuri
Specifies the URI of the Built-In Role.
Example: /v2/permissions/built-in-roles/f5f77dd6-71df-48a4-b4f4-d2605a79f3ca

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/permissions/built-in-roles/:built_in_role_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

built_in_role_id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!