Skip to main content
GET
/
v1
/
roles
/
{role}
cURL
curl --request GET \
  --url https://api.example.com/v1/roles/{role}
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ],
  "type": "TYPE_UNSPECIFIED"
}

Path Parameters

​
role
string
required

The role id.

Response

OK

Role defines a set of permissions that can be assigned to users.

​
name
string

Resource name. Format: roles/{role}

​
title
string

Human-readable title.

​
description
string

Optional description of the role.

​
permissions
string[]

List of permission identifiers granted by this role.

​
type
enum<string>

Role type indicating if it's built-in or custom.

Available options:
TYPE_UNSPECIFIED,
BUILT_IN,
CUSTOM