Class SeamHttpUserIdentities

constructor

• new SeamHttpUserIdentities(apiKeyOrOptions?): SeamHttpUserIdentities

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentities

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

enrollmentAutomations

• get enrollmentAutomations(): SeamHttpUserIdentitiesEnrollmentAutomations

• Returns SeamHttpUserIdentitiesEnrollmentAutomations

addAcsUser

• addAcsUser(parameters?, options?): UserIdentitiesAddAcsUserRequest

• Parameters

  • Optionalparameters: {
        acs_user_id: string;
        user_identity_id: string;
    }

    • acs_user_id: string

      ID of the access system user that you want to add to the user identity.

    • user_identity_id: string

      ID of the user identity to which you want to add an access system user.
  • options: UserIdentitiesAddAcsUserOptions = {}

  Returns UserIdentitiesAddAcsUserRequest

create

• create(parameters?, options?): UserIdentitiesCreateRequest

• Parameters

  • Optionalparameters: {
        acs_system_ids?: string[];
        email_address?: null | string;
        full_name?: null | string;
        phone_number?: null | string;
        user_identity_key?: null | string;
    }

    • Optionalacs_system_ids?: string[]

      List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.

    • Optionalemail_address?: null | string

      Unique email address for the new user identity.

    • Optionalfull_name?: null | string

      Full name of the user associated with the new user identity.

    • Optionalphone_number?: null | string

      Unique phone number for the new user identity in E.164 format (for example, +15555550100).

    • Optionaluser_identity_key?: null | string

      Unique key for the new user identity.
  • options: UserIdentitiesCreateOptions = {}

  Returns UserIdentitiesCreateRequest

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(parameters?, options?): UserIdentitiesDeleteRequest

• Parameters

  • Optionalparameters: {
        user_identity_id: string;
    }

    • user_identity_id: string

      ID of the user identity that you want to delete.
  • options: UserIdentitiesDeleteOptions = {}

  Returns UserIdentitiesDeleteRequest

generateInstantKey

• generateInstantKey(parameters?, options?): UserIdentitiesGenerateInstantKeyRequest

• Parameters

  • Optionalparameters: {
        max_use_count?: number;
        user_identity_id: string;
    }

    • Optionalmax_use_count?: number

      Maximum number of times the instant key can be used. Default: 1.

    • user_identity_id: string

      ID of the user identity for which you want to generate an instant key.
  • options: UserIdentitiesGenerateInstantKeyOptions = {}

  Returns UserIdentitiesGenerateInstantKeyRequest

get

• get(parameters?, options?): UserIdentitiesGetRequest

• Parameters

  • Optionalparameters: UserIdentitiesGetParameters
  • options: UserIdentitiesGetOptions = {}

  Returns UserIdentitiesGetRequest

grantAccessToDevice

• grantAccessToDevice(parameters?, options?): UserIdentitiesGrantAccessToDeviceRequest

• Parameters

  • Optionalparameters: {
        device_id: string;
        user_identity_id: string;
    }

    • device_id: string

      ID of the managed device to which you want to grant access to the user identity.

    • user_identity_id: string

      ID of the user identity that you want to grant access to a device.
  • options: UserIdentitiesGrantAccessToDeviceOptions = {}

  Returns UserIdentitiesGrantAccessToDeviceRequest

list

• list(parameters?, options?): UserIdentitiesListRequest

• Parameters

  • Optionalparameters: {
        credential_manager_acs_system_id?: string;
    }

    • Optionalcredential_manager_acs_system_id?: string

      acs_system_id of the credential manager by which you want to filter the list of user identities.
  • options: UserIdentitiesListOptions = {}

  Returns UserIdentitiesListRequest

listAccessibleDevices

• listAccessibleDevices(parameters?, options?): UserIdentitiesListAccessibleDevicesRequest

• Parameters

  • Optionalparameters: {
        user_identity_id: string;
    }

    • user_identity_id: string

      ID of the user identity for which you want to retrieve all accessible devices.
  • options: UserIdentitiesListAccessibleDevicesOptions = {}

  Returns UserIdentitiesListAccessibleDevicesRequest

listAcsSystems

• listAcsSystems(parameters?, options?): UserIdentitiesListAcsSystemsRequest

• Parameters

  • Optionalparameters: {
        user_identity_id: string;
    }

    • user_identity_id: string

      ID of the user identity for which you want to retrieve all access systems.
  • options: UserIdentitiesListAcsSystemsOptions = {}

  Returns UserIdentitiesListAcsSystemsRequest

listAcsUsers

• listAcsUsers(parameters?, options?): UserIdentitiesListAcsUsersRequest

• Parameters

  • Optionalparameters: {
        user_identity_id: string;
    }

    • user_identity_id: string

      ID of the user identity for which you want to retrieve all access system users.
  • options: UserIdentitiesListAcsUsersOptions = {}

  Returns UserIdentitiesListAcsUsersRequest

removeAcsUser

• removeAcsUser(parameters?, options?): UserIdentitiesRemoveAcsUserRequest

• Parameters

  • Optionalparameters: {
        acs_user_id: string;
        user_identity_id: string;
    }

    • acs_user_id: string

      ID of the access system user that you want to remove from the user identity..

    • user_identity_id: string

      ID of the user identity from which you want to remove an access system user.
  • options: UserIdentitiesRemoveAcsUserOptions = {}

  Returns UserIdentitiesRemoveAcsUserRequest

revokeAccessToDevice

• revokeAccessToDevice(parameters?, options?): UserIdentitiesRevokeAccessToDeviceRequest

• Parameters

  • Optionalparameters: {
        device_id: string;
        user_identity_id: string;
    }

    • device_id: string

      ID of the managed device to which you want to revoke access from the user identity.

    • user_identity_id: string

      ID of the user identity from which you want to revoke access to a device.
  • options: UserIdentitiesRevokeAccessToDeviceOptions = {}

  Returns UserIdentitiesRevokeAccessToDeviceRequest

update

• update(parameters?, options?): UserIdentitiesUpdateRequest

• Parameters

  • Optionalparameters: {
        email_address?: null | string;
        full_name?: null | string;
        phone_number?: null | string;
        user_identity_id: string;
        user_identity_key?: null | string;
    }

    • Optionalemail_address?: null | string

      Unique email address for the user identity.

    • Optionalfull_name?: null | string

      Full name of the user associated with the user identity.

    • Optionalphone_number?: null | string

      Unique phone number for the user identity.

    • user_identity_id: string

      ID of the user identity that you want to update.

    • Optionaluser_identity_key?: null | string

      Unique key for the user identity.
  • options: UserIdentitiesUpdateOptions = {}

  Returns UserIdentitiesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpUserIdentities

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpUserIdentities

StaticfromClient

• fromClient(client, options?): SeamHttpUserIdentities

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpUserIdentities

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpUserIdentities

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpUserIdentities

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpUserIdentities

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpUserIdentities

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpUserIdentities

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpUserIdentities

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpUserIdentities>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpUserIdentities>