Modify user

Modifies a user’s role in the organization.

POST /organization/users/{user_id}

Modify user

cURL

curl --request POST \
  --url https://api.openai.com/v1/organization/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "owner"
}
'

200

{
  "object": "organization.user",
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "role": "owner",
  "added_at": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_id · string · required

The ID of the user.

Body

application/json

The new user role to modify. This must be one of owner or member.

role · enum<string> · required

owner or reader

Available options: owner, reader

Response

200 - application/json

User role updated successfully.

Represents an individual user within an organization.

object · enum<string> · required

The object type, which is always organization.user

Available options: organization.user

id · string · required

The identifier, which can be referenced in API endpoints

name · string · required

The name of the user

email · string · required

The email address of the user

role · enum<string> · required

owner or reader

Available options: owner, reader

added_at · integer · required

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