Skip to Content
kosemdocs
ReferenceAPIRoles

Get role

Gets a role.

GET
/v1/roles/{role}

Gets a role.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

role*string

The role's ID, such as agents.user for roles/agents.user.

Match^[a-z][a-zA-Z.]*[a-zA-Z]$

Response Body

OK

application/json
  1. response
description*string

What the role is for.

grantableOn*array<string>

The types of resource the role can be granted on, such as resourcemanager.kosem.ai/Project: those with IAM policies that the role names, on each of which a permission of the role's own service holds, or all of them for a basic role.

includedPermissions*array<string>

The permissions the role grants, such as agents.agents.create. Each holds where the role is granted and on the resources below it of the type the permission is checked on.

name*string

Resource name, such as roles/agents.user, by which IAM policies grant the role.

title*string

Name shown in user interfaces, such as Agents User.

Example Request
curl -X GET 'https://api.kosem.ai/v1/roles/string'
Example Response
{
  "description": "string",
  "grantableOn": [
    "string"
  ],
  "includedPermissions": [
    "string"
  ],
  "name": "string",
  "title": "string"
}