Users

Modify user

Changed on

Modifies a user's role in the organization.

post/organization/users/{user_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/organization/users/{user_id}
  • Auth
    HTTP bearer

Path parameters

user_idstring required

The ID of the user.

Request body

rolestring nullable

owner or reader

role_idstring nullable

Role ID to assign to the user.

technical_levelstring nullable

Technical level metadata.

developer_personastring nullable

Developer persona metadata.

Response

User role updated successfully.

object'organization.user' required

The object type, which is always organization.user

idstring required

The identifier, which can be referenced in API endpoints

namestring nullable

The name of the user

emailstring nullable

The email address of the user

rolestring nullable

owner or reader

added_atinteger required

The Unix timestamp (in seconds) of when the user was added.

is_defaultboolean

Whether this is the organization's default user.

createdinteger

The Unix timestamp (in seconds) of when the user was created.

is_service_accountboolean

Whether the user is a service account.

is_scale_tier_authorized_purchaserboolean nullable

Whether the user is an authorized purchaser for Scale Tier.

is_scim_managedboolean

Whether the user is managed through SCIM.

api_key_last_used_atinteger nullable

The Unix timestamp (in seconds) of the user's last API key usage.

technical_levelstring nullable

The technical level metadata for the user.

developer_personastring nullable

The developer persona metadata for the user.

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d86203de41aeRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status