NAME

OpenAPI::Client::OpenAI::Path::organization-users-user_id - Documentation for the /organization/users/{user_id} path.

DESCRIPTION

This document describes the API endpoint at /organization/users/{user_id}.

PATHS

DELETE /organization/users/{user_id}

Deletes a user from the organization.

Operation ID

delete-user

$client->delete-user( ... );

Parameters

• user_id (in path) (Required) - The ID of the user.

  Type: string

Responses

Status Code: 200

User deleted successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

GET /organization/users/{user_id}

Retrieves a user by their identifier.

Operation ID

retrieve-user

$client->retrieve-user( ... );

Parameters

• user_id (in path) (Required) - The ID of the user.

  Type: string

Responses

Status Code: 200

User retrieved successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
      "object": "organization.user",
      "id": "user_abc",
      "name": "First Last",
      "email": "user@example.com",
      "role": "owner",
      "added_at": 1711471533
  }

POST /organization/users/{user_id}

Modifies a user's role in the organization.

Operation ID

modify-user

$client->modify-user( ... );

Parameters

• user_id (in path) (Required) - The ID of the user.

  Type: string

Request Body

Content Type: application/json

Responses

Status Code: 200

User role updated successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
      "object": "organization.user",
      "id": "user_abc",
      "name": "First Last",
      "email": "user@example.com",
      "role": "owner",
      "added_at": 1711471533
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI