Skip to content
API Reference
Organization
Users

Modify user

POST/organization/users/{user_id}

Modifies a user's role in the organization.

Path ParametersExpand Collapse
user_id: string
Body ParametersJSONExpand Collapse
role: "owner" or "reader"

owner or reader

Accepts one of the following:
"owner"
"reader"
ReturnsExpand Collapse
User = object { id, added_at, email, 3 more }

Represents an individual user within an organization.

id: string

The identifier, which can be referenced in API endpoints

added_at: number

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

email: string

The email address of the user

name: string

The name of the user

object: "organization.user"

The object type, which is always organization.user

role: "owner" or "reader"

owner or reader

Accepts one of the following:
"owner"
"reader"

Modify user

curl https://api.openai.com/v1/organization/users/$USER_ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "role": "owner"
        }'
{
  "id": "id",
  "added_at": 0,
  "email": "email",
  "name": "name",
  "object": "organization.user",
  "role": "owner"
}
Returns Examples
{
  "id": "id",
  "added_at": 0,
  "email": "email",
  "name": "name",
  "object": "organization.user",
  "role": "owner"
}