Assign organization role to group

1 parameter · 1 body field

group_idstringrequired

The ID of the group that should receive the organization role.

Identifies the organization role to assign to the group.

role_idstringrequired

Identifier of the role to assign.

2 status codes

200Organization role assigned to the group successfully.

objectstringrequired

Always `group.role`.

Allowed:group.role

groupobjectrequired

Summary information about a group returned in role assignment responses.

roleobjectrequired

Details about a role that can be assigned through the public Roles API.

429The request was rejected because a rate limit was exceeded.

errorobjectrequired

Error handling

A 429 is returned: The request was rejected because a rate limit was exceeded.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.roles.create({
  groupId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  roleId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "object": "group.role",
  "group": {
    "object": "group",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "created_at": 1,
    "scim_managed": true
  },
  "role": {
    "object": "role",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "description": "Example description",
    "permissions": [
      "example_value"
    ],
    "resource_type": "example_value",
    "predefined_role": true
  }
}

Request

Response

Errors