Class SeamHttpUserIdentities

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentities

client

Readonlydefaults

unmanaged

• get unmanaged(): SeamHttpUserIdentitiesUnmanaged

  Client for the Seam API /user_identities/unmanaged routes.

  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>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  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

  • Optionalparameters: 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

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>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpUserIdentities authenticated with an API key.

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromClient

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

  Creates a new SeamHttpUserIdentities from an existing HTTP client.

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromClientSessionToken

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

  Creates a new SeamHttpUserIdentities authenticated with a client session token.

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpUserIdentities authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpUserIdentities authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpUserIdentities

StaticfromPublishableKey

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

  Creates a new SeamHttpUserIdentities authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpUserIdentities>