OpenAI API (unofficial showcase)
POST/organization/users/{user_id}

Modify an organization user

Updates a user's role or metadata in the organization. Supply the body fields you want to change, such as role, role_id, technical_level, or developer_persona. The response contains the updated organization user.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

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

User role and metadata fields to update. The fields may be supplied as strings or null.

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

5 status codes
200Returns the updated organization user object, including the user's current role and metadata.
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.
400Returned when the requested user role is invalid or the update is not permitted.
errorobjectrequired
403Returned when the caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
404Returned when the user is not found in the organization.
errorobjectrequired
429Returned when management requests exceed the rate limit.
errorobjectrequired

Error handling

An invalid role or update that is not permitted returns a 400. The user_id path parameter must identify a user in the organization; a 404 is returned if the user is not found. A 403 is returned when the authenticated user lacks permission, and a 429 is returned when management requests exceed the rate limit.