Assign project role to user | OpenAI API (unofficial showcase)

2 parameters · 1 body field

project_idstringrequired

The ID of the project to update.

user_idstringrequired

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

Identifies the project role to assign to the user.

role_idstringrequired

Identifier of the role to assign.

5 status codes

200Project 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.

400The request parameters are invalid or the requested operation cannot be performed.

errorobjectrequired

403The caller does not have permission to perform this operation.

errorobjectrequired

Details about the permission error.

404The endpoint is unavailable or a requested resource was not found in this organization or project.

errorobjectrequired

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

errorobjectrequired

Error handling

A 400 is returned: The request parameters are invalid or the requested operation cannot be performed. A 403 is returned: The caller does not have permission to perform this operation. A 404 is returned: The endpoint is unavailable or a requested resource was not found in this organization or project. A 429 is returned: The request was rejected because a rate limit was exceeded.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.roles.create({
  projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  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