Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization

Users

List users
client.Admin.Organization.Users.List(ctx, query) (*ConversationCursorPage[OrganizationUser], error)
GET/organization/users
Retrieve user
client.Admin.Organization.Users.Get(ctx, userID) (*OrganizationUser, error)
GET/organization/users/{user_id}
Modify user
client.Admin.Organization.Users.Update(ctx, userID, body) (*OrganizationUser, error)
POST/organization/users/{user_id}
Delete user
client.Admin.Organization.Users.Delete(ctx, userID) (*AdminOrganizationUserDeleteResponse, error)
DELETE/organization/users/{user_id}
ModelsExpand Collapse
type OrganizationUser struct{…}

Represents an individual user within an organization.

ID string

The identifier, which can be referenced in API endpoints

AddedAt int64

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

formatunixtime
Object OrganizationUser

The object type, which is always organization.user

APIKeyLastUsedAt int64Optional

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

formatunixtime
Created int64Optional

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

formatunixtime
DeveloperPersona stringOptional

The developer persona metadata for the user.

Email stringOptional

The email address of the user

IsDefault boolOptional

Whether this is the organization’s default user.

IsScaleTierAuthorizedPurchaser boolOptional

Whether the user is an authorized purchaser for Scale Tier.

IsScimManaged boolOptional

Whether the user is managed through SCIM.

IsServiceAccount boolOptional

Whether the user is a service account.

Name stringOptional

The name of the user

Projects OrganizationUserProjectsOptional

Projects associated with the user, if included.

Data []OrganizationUserProjectsData
ID stringOptional
Name stringOptional
Role stringOptional
Object List
Role stringOptional

owner or reader

TechnicalLevel stringOptional

The technical level metadata for the user.

User OrganizationUserUserOptional

Nested user details.

ID string
Object User
Banned boolOptional
BannedAt int64Optional
formatunixtime
Email stringOptional
Enabled boolOptional
Name stringOptional
Picture stringOptional

UsersRoles

List user organization role assignments
client.Admin.Organization.Users.Roles.List(ctx, userID, query) (*NextCursorPage[AdminOrganizationUserRoleListResponse], error)
GET/organization/users/{user_id}/roles
Assign organization role to user
client.Admin.Organization.Users.Roles.New(ctx, userID, body) (*AdminOrganizationUserRoleNewResponse, error)
POST/organization/users/{user_id}/roles
Unassign organization role from user
client.Admin.Organization.Users.Roles.Delete(ctx, userID, roleID) (*AdminOrganizationUserRoleDeleteResponse, error)
DELETE/organization/users/{user_id}/roles/{role_id}