ClientService

Get User

Returns the requested User by its resource name. A caller authenticated as a user can use organizations/-/users/me to get its own user. Integrations are not users, so the alias returns PERMISSION_DENIED for them.

get/v1/organizations/{organization}/users/{user}

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1/organizations/{organization}/users/{user}
  • Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

userstring required

The user identifier of the resource path.

Response

A successful response.

namestring

The unique resource name of the user. Format: organizations/{organization}/users/{user}. This field is system-generated and immutable.

emailstring required

Required. The email address of the user. The invitation to join the organization is sent to this address. Must be a valid RFC 5322 compliant email address. Must not already be in use by another user on the platform, including users in other organizations; creation fails if it is. This field is immutable after creation.

displayNamestring

Optional. The human readable name of the user. For a human user, this would be their full name. For other entities, this is a descriptive name that can be used to identify them, such as "ACME Integrations Service Account".

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE' | 'INVITED' | 'DELETED'

The lifecycle state of the user.

  • STATE_UNSPECIFIED: Default value. This value is unused.

  • ACTIVE: The user is active and can interact with the API.

  • INACTIVE: The user has been deactivated and cannot interact with the API.

  • INVITED: The user has been invited but has not yet interacted with the API. They become ACTIVE when they first interact with the API.

  • DELETED: The user has been deleted and cannot interact with the API.

lastSeenstring date-time

The last time the user interacted with the API.

deleteTimestring date-time

The time at which the user was soft-deleted. Only set for soft-deleted users.

Changes

No recorded changes to this operation across all 1 revision of this API.