Assign Role To User In Organization

UserOrganizationRole organizations().users().assignRole(, )

PUT/api/v1/organizations/{organization_id}/users/roles

Assign a role to a user in an organization.

ParametersExpand Collapse

UserAssignRoleParams params

Optional<String> pathOrganizationId

String bodyOrganizationId

The organization’s ID.

formatuuid

String roleId

The role’s ID.

formatuuid

String userId

The user’s ID.

ReturnsExpand Collapse

class UserOrganizationRole:

Schema for a user’s role in an organization.

String id

Unique identifier

formatuuid

String organizationId

The organization’s ID.

formatuuid

Role role

The role.

String id

Unique identifier

formatuuid

String name

A name for the role.

maxLength3000

minLength1

List<Permission> permissions

The actual permissions of the role.

String id

Unique identifier

formatuuid

boolean access

Whether the permission is granted or not.

Optional<String> description

A description for the permission.

String name

A name for the permission.

maxLength3000

minLength1

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

String userId

The user’s ID.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<List<String>> projectIds

The project ID scope.

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Assign Role To User In Organization

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.organizations.UserOrganizationRole;
import ai.llamaindex.llamacloudadmin.models.organizations.users.UserAssignRoleParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

        UserAssignRoleParams params = UserAssignRoleParams.builder()
            .pathOrganizationId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .bodyOrganizationId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .roleId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .userId("user_id")
            .build();
        UserOrganizationRole userOrganizationRole = client.organizations().users().assignRole(params);
    }
}

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "role": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "permissions": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "access": true,
        "description": "description",
        "name": "x",
        "created_at": "2019-12-27T18:11:19.117Z",
        "updated_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "created_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "project_ids": [
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "role": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "permissions": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "access": true,
        "description": "description",
        "name": "x",
        "created_at": "2019-12-27T18:11:19.117Z",
        "updated_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "created_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "project_ids": [
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}