Get a Role by Id

Get a specific role by its roleId.

caution

This endpoint has been deprecated and will be phased out at the end of 2023. Please update any existing usages of it to use the Get Object endpoint instead.

Endpoint

GET /v1/roles/:roleId

Parameters

Parameter	Description	Type	Required
roleId	Id of the role to retrieve.	URL param	yes

Request

cURL

curl "https://api.warrant.dev/v1/roles/admin" \
    -H "Authorization: ApiKey YOUR_KEY"

Go

role, err := role.Get("admin")
if err != nil {
    // handle error
}

Java

Role role = client.getRole("admin");

Node.js

const role = await warrantClient.Role.get("admin");

Python

role = warrant.Role.get("admin")

Ruby

role = Warrant::Role.get("admin")

PHP

$role = $warrant->getRole("admin");

Response

{
  "roleId": "admin",
  "name": "Admin",
  "desciption": "Grants a user admin access to the application"
}