Sample - OpenAI API
POST/organization/users/{user_id}

Modify an organization user's role

Updates an organization user's role and associated metadata. Use user_id to select the user and provide the role assignment or metadata fields to change in the request body. The response returns the updated organization user object.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 4 body fields
user_idstringrequired
The identifier of the organization user to modify.

The role assignment and optional metadata to apply to the organization user. The documented role values are owner and member.

rolestringoptional
`owner` or `reader`
role_idstringoptional
Role ID to assign to the user.
technical_levelstringoptional
Technical level metadata.
developer_personastringoptional
Developer persona metadata.

1 status code
200Returns the updated organization user object with its role, metadata, timestamps, and organization status flags.
objectstringrequired
The object type, which is always `organization.user`
Allowed:organization.user
idstringrequired
The identifier, which can be referenced in API endpoints
namestringoptional
The name of the user
emailstringoptional
The email address of the user
rolestringoptional
`owner` or `reader`
added_atintegerrequired
The Unix timestamp (in seconds) of when the user was added.
is_defaultbooleanoptional
Whether this is the organization's default user.
createdintegeroptional
The Unix timestamp (in seconds) of when the user was created.
userobjectoptional
Nested user details.
is_service_accountbooleanoptional
Whether the user is a service account.
is_scale_tier_authorized_purchaserbooleanoptional
Whether the user is an authorized purchaser for Scale Tier.
is_scim_managedbooleanoptional
Whether the user is managed through SCIM.
api_key_last_used_atintegeroptional
The Unix timestamp (in seconds) of the user's last API key usage.
technical_levelstringoptional
The technical level metadata for the user.
developer_personastringoptional
The developer persona metadata for the user.
projectsobjectoptional
Projects associated with the user, if included.

Error handling

user_id must identify an existing organization user. role must use an accepted organization role, and role_id identifies the role assignment when you assign a role by identifier.