Get Roles

Get list of roles.

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 List Objects endpoint instead.

Endpoint

GET /v1/roles

Request

cURL

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

Go

roles, err := role.ListRoles(&warrant.ListRoleParams{
    ListParams: warrant.ListParams{
        Page:  1,
        Limit: 10,
    },
})
if err != nil {
    // handle error
}

Java

int limit = 10;
int page = 1;
Role[] roles = client.listRoles(limit, page);

Node.js

await warrantClient.Role.listRoles({ limit: 10, page: 1 });

Python

roles = warrant.Role.list()

Ruby

roles = Warrant::Role.list()

PHP

CLI

warrant list roles

Response

[
  {
    "roleId": "admin"
  },
  {
    "roleId": "owner"
  },
  {
    "roleId": "role2"
  }
]