Assign organization role to user | Sample

1 parameter · 1 body field

user_idstringrequired

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

Identifies the organization role to assign to the user.

role_idstringrequired

Identifier of the role to assign.

2 status codes

200Organization role assigned to the user successfully.

objectstringrequired

Always `user.role`.

Allowed:user.role

userobjectrequired

Represents an individual `user` within an organization.

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({
  userId: "c0a80123-4567-89ab-cdef-0123456789ab",
  roleId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "object": "user.role",
  "user": {
    "object": "organization.user",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "email": "user@example.com",
    "role": "administrator",
    "added_at": 1,
    "is_default": true,
    "created": 1,
    "user": {
      "object": "user",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "user@example.com",
      "name": "Example Name",
      "picture": "example_value",
      "enabled": true,
      "banned": true,
      "banned_at": 1
    },
    "is_service_account": true,
    "is_scale_tier_authorized_purchaser": true,
    "is_scim_managed": true,
    "api_key_last_used_at": "example_key_abc123",
    "technical_level": "example_value",
    "developer_persona": "example_value",
    "projects": {
      "object": "list",
      "data": [
        {
          "id": null,
          "name": null,
          "role": null
        }
      ]
    }
  },
  "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