Skip to main content
POST
/
v1
/
roles
cURL
curl --request POST \
  --url https://api.example.com/v1/roles \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ],
  "type": "TYPE_UNSPECIFIED"
}
'
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ],
  "type": "TYPE_UNSPECIFIED"
}

Query Parameters

​
roleId
string

The ID to use for the role, which will become the final component of the role's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/.

Body

application/json

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

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