Class SeamHttpUserIdentities

constructor

• new SeamHttpUserIdentities(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpUserIdentities

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentities

client

Readonlydefaults

unmanaged

• get unmanaged(): SeamHttpUserIdentitiesUnmanaged

  Returns SeamHttpUserIdentitiesUnmanaged

addAcsUser

• addAcsUser(
      parameters: UserIdentitiesAddAcsUserParameters,
      options?: UserIdentitiesAddAcsUserOptions,
  ): UserIdentitiesAddAcsUserRequest

  Adds a specified access system user to a specified user identity.

  You must specify either user_identity_id or user_identity_key to identify the user identity.

  If user_identity_key is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.

  Parameters

  • parameters: UserIdentitiesAddAcsUserParameters
  • options: UserIdentitiesAddAcsUserOptions = {}

  Returns UserIdentitiesAddAcsUserRequest

create

• create(
      parameters?: UserIdentitiesCreateParameters,
      options?: UserIdentitiesCreateOptions,
  ): UserIdentitiesCreateRequest

  Creates a new user identity.

  Parameters

  • Optionalparameters: UserIdentitiesCreateParameters
  • options: UserIdentitiesCreateOptions = {}

  Returns UserIdentitiesCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): 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: UserIdentitiesDeleteParameters,
      options?: UserIdentitiesDeleteOptions,
  ): UserIdentitiesDeleteRequest

  Deletes a specified user identity. This deletes the user identity and all associated resources, including any credentials, acs users and client sessions.

  Parameters

  • parameters: UserIdentitiesDeleteParameters
  • options: UserIdentitiesDeleteOptions = {}

  Returns UserIdentitiesDeleteRequest

generateInstantKey

• generateInstantKey(
      parameters: UserIdentitiesGenerateInstantKeyParameters,
      options?: UserIdentitiesGenerateInstantKeyOptions,
  ): UserIdentitiesGenerateInstantKeyRequest

  Generates a new instant key for a specified user identity.

  Parameters

  • parameters: UserIdentitiesGenerateInstantKeyParameters
  • options: UserIdentitiesGenerateInstantKeyOptions = {}

  Returns UserIdentitiesGenerateInstantKeyRequest

get

• get(
      parameters: UserIdentitiesGetParameters,
      options?: UserIdentitiesGetOptions,
  ): UserIdentitiesGetRequest

  Returns a specified user identity.

  Parameters

  • parameters: UserIdentitiesGetParameters
  • options: UserIdentitiesGetOptions = {}

  Returns UserIdentitiesGetRequest

grantAccessToDevice

• grantAccessToDevice(
      parameters: UserIdentitiesGrantAccessToDeviceParameters,
      options?: UserIdentitiesGrantAccessToDeviceOptions,
  ): UserIdentitiesGrantAccessToDeviceRequest

  Grants a specified user identity access to a specified device.

  Parameters

  • parameters: UserIdentitiesGrantAccessToDeviceParameters
  • options: UserIdentitiesGrantAccessToDeviceOptions = {}

  Returns UserIdentitiesGrantAccessToDeviceRequest

list

• list(
      parameters?: UserIdentitiesListParameters,
      options?: UserIdentitiesListOptions,
  ): UserIdentitiesListRequest

  Returns a list of all user identities.

  Parameters

  • Optionalparameters: UserIdentitiesListParameters
  • options: UserIdentitiesListOptions = {}

  Returns UserIdentitiesListRequest

listAccessibleDevices

• listAccessibleDevices(
      parameters: UserIdentitiesListAccessibleDevicesParameters,
      options?: UserIdentitiesListAccessibleDevicesOptions,
  ): UserIdentitiesListAccessibleDevicesRequest

  Returns a list of all devices associated with a specified user identity. This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.

  Parameters

  • parameters: UserIdentitiesListAccessibleDevicesParameters
  • options: UserIdentitiesListAccessibleDevicesOptions = {}

  Returns UserIdentitiesListAccessibleDevicesRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters: UserIdentitiesListAccessibleEntrancesParameters,
      options?: UserIdentitiesListAccessibleEntrancesOptions,
  ): UserIdentitiesListAccessibleEntrancesRequest

  Returns a list of all ACS entrances accessible to a specified user identity. This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.

  Parameters

  • parameters: UserIdentitiesListAccessibleEntrancesParameters
  • options: UserIdentitiesListAccessibleEntrancesOptions = {}

  Returns UserIdentitiesListAccessibleEntrancesRequest

listAcsSystems

• listAcsSystems(
      parameters: UserIdentitiesListAcsSystemsParameters,
      options?: UserIdentitiesListAcsSystemsOptions,
  ): UserIdentitiesListAcsSystemsRequest

  Returns a list of all access systems associated with a specified user identity.

  Parameters

  • parameters: UserIdentitiesListAcsSystemsParameters
  • options: UserIdentitiesListAcsSystemsOptions = {}

  Returns UserIdentitiesListAcsSystemsRequest

listAcsUsers

• listAcsUsers(
      parameters: UserIdentitiesListAcsUsersParameters,
      options?: UserIdentitiesListAcsUsersOptions,
  ): UserIdentitiesListAcsUsersRequest

  Returns a list of all access system users assigned to a specified user identity.

  Parameters

  • parameters: UserIdentitiesListAcsUsersParameters
  • options: UserIdentitiesListAcsUsersOptions = {}

  Returns UserIdentitiesListAcsUsersRequest

merge

• merge(
      parameters: UserIdentitiesMergeParameters,
      options?: UserIdentitiesMergeOptions,
  ): UserIdentitiesMergeRequest

  Merges one or more user identities into a primary user identity, for when the same person ended up with more than one user identity.

  The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as merged_user_identity_ids and merged_user_identity_keys.

  Access grants, access system users, client sessions and other resources belonging to the merged user identities are moved to the primary user identity.

  Identify the user identities either by ID or by key, but not both in the same request. Repeating a merge that has already been applied makes no further changes.

  Parameters

  • parameters: UserIdentitiesMergeParameters
  • options: UserIdentitiesMergeOptions = {}

  Returns UserIdentitiesMergeRequest

removeAcsUser

• removeAcsUser(
      parameters: UserIdentitiesRemoveAcsUserParameters,
      options?: UserIdentitiesRemoveAcsUserOptions,
  ): UserIdentitiesRemoveAcsUserRequest

  Removes a specified access system user from a specified user identity.

  Parameters

  • parameters: UserIdentitiesRemoveAcsUserParameters
  • options: UserIdentitiesRemoveAcsUserOptions = {}

  Returns UserIdentitiesRemoveAcsUserRequest

revokeAccessToDevice

• revokeAccessToDevice(
      parameters: UserIdentitiesRevokeAccessToDeviceParameters,
      options?: UserIdentitiesRevokeAccessToDeviceOptions,
  ): UserIdentitiesRevokeAccessToDeviceRequest

  Revokes access to a specified device from a specified user identity.

  Parameters

  • parameters: UserIdentitiesRevokeAccessToDeviceParameters
  • options: UserIdentitiesRevokeAccessToDeviceOptions = {}

  Returns UserIdentitiesRevokeAccessToDeviceRequest

update

• update(
      parameters: UserIdentitiesUpdateParameters,
      options?: UserIdentitiesUpdateOptions,
  ): UserIdentitiesUpdateRequest

  Updates a specified user identity.

  Parameters

  • parameters: UserIdentitiesUpdateParameters
  • options: UserIdentitiesUpdateOptions = {}

  Returns UserIdentitiesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpUserIdentities

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpUserIdentities

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpUserIdentities

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpUserIdentities

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpUserIdentities

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpUserIdentities>