@toznysecure/account-sdk / Exports / Client

Class: Client

The client for Tozny's Account API.

This documentation is automatically generated from the code. It is currently a work in progress as we refine our type definitions & document more and more of the API.

example

const { Account } = require('@toznysecure/account-sdk')
const Tozny = require('@toznysecure/sdk/node')

const accountFactory = new Account(Tozny, TOZNY_PLATFORM_API_URL)

// must be used inside an async function for access to `await`
const account = await accountFactory.login(USERNAME, PASSWORD)
const accountClient = account.client

addBillingCoupon
addDefaultRealmGroups
addGroupRoleMappings
addRolesToIdentity
billingStatus
changePassword
createRealm
createRealmApplicationRole
createRealmGroup
createRealmRole
deleteIdentity
deleteMFA
deleteRealm
deleteRealmApplicationRole
deleteRealmGroup
deleteRealmRole
deleteRegistrationToken
deleteWebhook
describeRealmApplicationRole
describeRealmGroup
describeRealmRole
getAggregations
getClientInfo
getMFA
getRealmUserCount
getRequests
groupMembership
hostedBrokerInfo
identityDetails
initiateTotp
initiateWebAuthn
joinGroups
leaveGroups
listAccessPoliciesForGroups
listApplications
listApplicationsByClientIDs
listClientInfo
listDefaultRealmGroups
listGroupRoleMappings
listIdentities
listRealmApplicationRoles
listRealmGroups
listRealmRoles
listRealms
newRegistrationToken
newWebhook
refreshProfile
registerIdentity
registerRealmBrokerIdentity
registerTotp
registerWebAuthnDevice
registrationTokens
removeDefaultRealmGroups
removeGroupRoleMappings
replaceDefaultRealmGroups
resendVerificationEmail
serialize
setClientEnabled
subscribe
unsubscribe
updateAccountBilling
updateGroupMembership
updateProfile
updateRealmApplicationRole
updateRealmGroup
updateRealmRole
updateRealmSettings
upsertAccessPoliciesForGroup
validatePassword
webhooks

Constructors

constructor

• new Client(api, account, profile, queenClient)

Parameters

Name	Type
`api`	`API`
`account`	`Account`
`profile`	`any`
`queenClient`	`any`

Defined in

client.ts:64

Properties

account

• account: Account

Defined in

client.ts:60

profile

• profile: any

Defined in

client.ts:61

Accessors

queenClient

• get queenClient(): any

Returns

any

Defined in

client.ts:76

Methods

addBillingCoupon

▸ addBillingCoupon(couponCode): Promise<any>

Parameters

Name	Type
`couponCode`	`string`

Returns

Promise<any>

Defined in

client.ts:171

addDefaultRealmGroups

▸ addDefaultRealmGroups(realmName, groups): Promise<boolean>

Add default groups for the request realm. note: when default realm groups are changed existing users' groups are not updated

example

const toznyEngineersGroup = await client.createRealmGroup(realmName, {
  name: 'ToznyEngineers',
})
await client.addDefaultRealmGroups(realmName, {
  groups: [toznyEngineersGroup.id],
})

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groups`	`GroupsInput`	List of groups or group ids in an object on the `groups` key

Returns

Promise<boolean>

Defined in

client.ts:933

addGroupRoleMappings

▸ addGroupRoleMappings(realmName, groupId, groupRoleMapping): Promise<boolean>

Adds a set of realm/client roles to a group's role mapping

example

const realmName = 'kitchen'
const chefGroup = await client.createRealmGroup(realmName, { name: 'Chefs' })
const fridgeAccessRole = await client.createRealmRole(realmName, {
  name: 'FridgeAccess',
  description: 'Grants access to the secrets of the fridge.',
})

// map the "Chefs" realm group to the "FridgeAccess" realm role
// returns true on success
await client.addGroupRoleMappings(
  realmName,
  chefGroup.id,
  { realm: [fridgeAccessRole] }
)

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupId`	`string`	Id of realm group.
`groupRoleMapping`	`GroupRoleMapping`	The map of roles to add to group's mapping.

Returns

Promise<boolean>

True if successful

Defined in

client.ts:718

addRolesToIdentity

▸ addRolesToIdentity(realmName, identityId, roles): Promise<boolean>

Add role to an identity.

example

// Get the identityId you wish to delete
const identity = accountClient.identityDetails(realmName, username)

// Add role to the identity.
await accountClient.addRolesToIdentity(realmName, toznyId, roles)

Parameters

Name	Type	Description
`realmName`	`string`	Name of the realm.
`identityId`	`string`	Id of Tozny identity.
`roles`	`string`[]	String Array of roles. Both realm and client roles.

Returns

Promise<boolean>

True if successful.

Defined in

client.ts:1054

billingStatus

▸ billingStatus(): Promise<fn>

Returns

Promise<fn>

Defined in

client.ts:161

changePassword

▸ changePassword(__namedParameters): Promise<any>

Parameters

Name	Type
`__namedParameters`	`Object`

Returns

Promise<any>

Defined in

client.ts:92

createRealm

▸ createRealm(realmName, sovereignName, realmRegistrationToken?): Promise<Realm>

Requests the creation of a new TozID Realm.

Parameters

Name	Type	Default value	Description
`realmName`	`string`	`undefined`	The user defined name for the realm to create.
`sovereignName`	`string`	`undefined`	The user defined name for the ruler of the realm to create.
`realmRegistrationToken`	`string`	`''`	-

Returns

Promise<Realm>

The representation of the created realm returned by the server.

Defined in

client.ts:338

createRealmApplicationRole

▸ createRealmApplicationRole(realmName, applicationId, role): Promise<Role>

Creates a new application role for a realm.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`applicationId`	`string`	Id of client application.
`role`	`MinimumRoleData`	Object with `name` and `description` of role.

Returns

Promise<Role>

The newly created role.

Defined in

client.ts:573

createRealmGroup

▸ createRealmGroup(realmName, group): Promise<Group>

Creates a new group in the realm.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`group`	`Object`	Object containing `name` of group.
`group.name`	`string`	-

Returns

Promise<Group>

The newly created group.

Defined in

client.ts:410

createRealmRole

▸ createRealmRole(realmName, role): Promise<Role>

Creates a new role for a realm.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`role`	`MinimumRoleData`	Object with `name` and `description` of role.

Returns

Promise<Role>

The newly created role.

Defined in

client.ts:495

deleteIdentity

▸ deleteIdentity(realmName, identityId): Promise<boolean>

Removes an identity in the given realm.

example

// Get the identityId you wish to delete
const identity = accountClient.identityDetails(realmName, username)

// Delete identity
await accountClient.deleteIdentity(realmName, identity.toznyId)

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`identityId`	`string`	Id of Tozny identity

Returns

Promise<boolean>

True if successful

Defined in

client.ts:1031

deleteMFA

▸ deleteMFA(id): Promise<Response>

Delete MFA

Parameters

Name	Type
`id`	`any`

Returns

Promise<Response>

Defined in

client.ts:1445

deleteRealm

▸ deleteRealm(realmName): Promise<object>

Requests the deletion of a named TozID Realm belonging to the account.

Parameters

Name	Type	Description
`realmName`	`string`	The name for the realm to delete.

Returns

Promise<object>

Empty object.

Defined in

client.ts:384

deleteRealmApplicationRole

▸ deleteRealmApplicationRole(realmName, applicationId, roleName): Promise<boolean>

Deletes a realm application role by id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`applicationId`	`string`	Id of client application.
`roleName`	`string`	Name of role to delete.

Returns

Promise<boolean>

True if successful.

Defined in

client.ts:620

deleteRealmGroup

▸ deleteRealmGroup(realmName, groupId): Promise<boolean>

Deletes a group in the named realm by id.

Parameters

Name	Type	Description
`realmName`	`string`	The name of the realm containing the group.
`groupId`	`string`	The id of the group to delete.

Returns

Promise<boolean>

True if successful.

Defined in

client.ts:482

deleteRealmRole

▸ deleteRealmRole(realmName, roleId): Promise<boolean>

Deletes a realm role by id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`roleId`	`string`	Id of role to delete.

Returns

Promise<boolean>

True if successful.

Defined in

client.ts:536

deleteRegistrationToken

▸ deleteRegistrationToken(token): Promise<boolean>

Removes a token object from the accounts available tokens.

Parameters

Name	Type	Description
`token`	`Token`	The token to remove from the account.

Returns

Promise<boolean>

True if the operation succeeds.

Defined in

client.ts:245

deleteWebhook

▸ deleteWebhook(webhookId): Promise<boolean>

Removes a webhook object from the accounts available webhooks.

Parameters

Name	Type
`webhookId`	`string`

Returns

Promise<boolean>

True if the operation succeeds.

Defined in

client.ts:283

describeRealmApplicationRole

▸ describeRealmApplicationRole(realmName, applicationId, roleName): Promise<Role>

Describe a realm application role by id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`applicationId`	`string`	Id of client application.
`roleName`	`string`	Name of role to describe.

Returns

Promise<Role>

Defined in

client.ts:641

describeRealmGroup

▸ describeRealmGroup(realmName, groupId): Promise<Group>

Describe a realm group by id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupId`	`string`	Id of group to describe.

Returns

Promise<Group>

Defined in

client.ts:429

describeRealmRole

▸ describeRealmRole(realmName, roleId): Promise<Role>

Describe a realm role by id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`roleId`	`string`	Id of role to describe.

Returns

Promise<Role>

Defined in

client.ts:547

getAggregations

▸ getAggregations(startTime, endTime): object

Gets aggregations for the api calls made in a given time frame.

Parameters

Name	Type	Description
`startTime`	`string`	Start time for range of requests
`endTime`	`string`	End time for range of requests

Returns

object

aggregations response object

Defined in

client.ts:321

getClientInfo

▸ getClientInfo(clientId): Promise<fn>

Parameters

Name	Type
`clientId`	`string`

Returns

Promise<fn>

Defined in

client.ts:192

getMFA

▸ getMFA(): Promise<any>

Get MFA devices

Returns

Promise<any>

Defined in

client.ts:1438

getRealmUserCount

▸ getRealmUserCount(realmName): Promise<object>

Requests the user count of a specified TozID Realm

Parameters

Name	Type	Description
`realmName`	`string`	The name for the realm to delete.

Returns

Promise<object>

The user count

Defined in

client.ts:369

getRequests

▸ getRequests(startTime, endTime, nextToken, endpointsToExclude): object

Gets the api request history using provided params.

Parameters

Name	Type	Description
`startTime`	`string`	Start time for range of requests
`endTime`	`string`	End time for range of requests
`nextToken`	`number`	allows backend to paginate requests
`endpointsToExclude`	`any`	-

Returns

object

request response object

Defined in

client.ts:297

groupMembership

▸ groupMembership(realmName, identityToznyId): Promise<Group[]>

List all realm groups for an identity

example

const identity = await accountClient.identityDetails(realmName, username)
const groupList = await client.groupMembership(realmName, identity.toznyId)

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`identityToznyId`	`string`	Id of Tozny identity

Returns

Promise<Group[]>

Defined in

client.ts:764

hostedBrokerInfo

▸ hostedBrokerInfo(): Promise<object>

Gets the public info about the Tozny hosted broker

Returns

Promise<object>

The hosted broker public info.

Defined in

client.ts:1109

identityDetails

▸ identityDetails(realmName, username): Promise<DetailedIdentity>

Fetches the details of an identity by username.

Parameters

Name	Type
`realmName`	`string`
`username`	`string`

Returns

Promise<DetailedIdentity>

The identity

Defined in

client.ts:1182

initiateTotp

▸ initiateTotp(): Promise<any>

Initiate Totp. Get QR info from API

Returns

Promise<any>

response

Defined in

client.ts:1422

initiateWebAuthn

▸ initiateWebAuthn(): Promise<any>

Initiate WebAuthn

Returns

Promise<any>

Defined in

client.ts:1452

joinGroups

▸ joinGroups(realmName, identityToznyId, groups): Promise<boolean>

Join a list of Realm groups for an identity

example

const identity = await accountClient.identityDetails(realmName, username)
const toznyEngineersGroup = await client.createRealmGroup(realmName, {
  name: 'ToznyEngineers',
})
await client.joinGroups(realmName, identity.toznyId, {
  groups: [toznyEngineersGroup.id],
})

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`identityToznyId`	`string`	Id of Tozny identity
`groups`	`GroupsInput`	List of groups or group ids to join in an object on the `groups` key

Returns

Promise<boolean>

True if successful

Defined in

client.ts:824

leaveGroups

▸ leaveGroups(realmName, identityToznyId, groups): Promise<boolean>

Leave a list of Realm Groups for an identity

example

const identity = await accountClient.identityDetails(realmName, username)
const toznyEngineersGroup = await client.createRealmGroup(realmName, {
  name: 'ToznyEngineers',
})
await client.joinGroups(realmName, identity.toznyId, {
  groups: [toznyEngineersGroup.id],
})
await client.leaveGroups(realmName, identity.toznyId, {
  groups: [toznyEngineersGroup.id],
})

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`identityToznyId`	`string`	Id of Tozny identity
`groups`	`GroupsInput`	List of groups or group ids to leave in an object on the `groups` key

Returns

Promise<boolean>

True if successful

Defined in

client.ts:858

listAccessPoliciesForGroups

▸ listAccessPoliciesForGroups(realmName, groupIds): Promise<ListAccessPoliciesResponse>

Lists the Current Access Policies for the Group Ids sent. Additionally configuration settings info about multi-party control for the realm is included.

The method handles multiple group ids and returns access policy information about each one in the same order on the groupAccessPolicies of the response.

example

const realmName = 'westeros'
const groupId = '200dd632-3faf-48d0-933f-e3ed40e27d92'
const data = await accountClient.listAccessPoliciesForGroups(
  realmName,
  [groupId]
)
// here we see the MPC settings for the realm.
// additionally, we see that access to the group is governed by access policy #131
// {
//   "settings": {
//     "defaultAccessDurationSeconds": 10800,
//     "defaultRequiredApprovals": 1,
//     "mpcEnabledForRealm": true
//   },
//   "groupAccessPolicies": [
//     {
//       "id": "200dd632-3faf-48d0-933f-e3ed40e27d92",
//       "accessPolicies": [
//         {
//           "id": 131,
//           "approvalRoles": [
//             {
//               "id": "24613e76-5a9d-4803-a55e-5f8d9e598f4e",
//               "name": "approver-role",
//               "description": "It will be the role approvers must have.",
//             }
//           ],
//           "maxAccessDurationSeconds": 172800,
//           "requiredApprovals": 1
//         }
//       ]
//     }
//   ]
// }

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupIds`	`string`[]	The IDs for the Tozny Groups

Returns

Promise<ListAccessPoliciesResponse>

Defined in

client.ts:1267

listApplications

▸ listApplications(realmName): Promise<RealmApplication[]>

Lists all the applications for the realm.

example

const realmName = 'westeros'
// Get a list of realm applications
const applications = await accountClient.listApplications(realmName)

Parameters

Name	Type	Description
`realmName`	`string`	Name of the realm

Returns

Promise<RealmApplication[]>

Defined in

client.ts:1362

listApplicationsByClientIDs

▸ listApplicationsByClientIDs(realmName, applicationClientIDs): RealmApplication[]

Lists all the applications for the realm with the provided client IDs.

example

const realmName = 'westeros'
// An array of the client IDs for applications to list
const clientIds = ['account']
const applications = await accountClient.listApplicationsByClientIDs(
   realmName,
   clientIds
)
// Get the application id for the application with client OD
const applicationID = applications[0].id

Parameters

Name	Type	Description
`realmName`	`string`	Name of the realm
`applicationClientIDs`	`string`[]	Client IDs of the applications to list

Returns

RealmApplication[]

Defined in

client.ts:1391

listClientInfo

▸ listClientInfo(nextToken?, perPage?): Promise<fn>

Parameters

Name	Type	Default value
`nextToken`	`number`	`0`
`perPage`	`number`	`50`

Returns

Promise<fn>

Defined in

client.ts:183

listDefaultRealmGroups

▸ listDefaultRealmGroups(realmName): Promise<Group[]>

Lists all default groups for the request realm.

example

const groupList = await client.listDefaultRealmGroups(realmName)

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.

Returns

Promise<Group[]>

List of all groups at realm.

Defined in

client.ts:880

listGroupRoleMappings

▸ listGroupRoleMappings(realmName, groupId): Promise<GroupRoleMapping>

Gets realm & client (application) roles that are mapped to a particular realm group.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupId`	`string`	Id of group for which to list role mappings.

Returns

Promise<GroupRoleMapping>

List of all roles at realm.

Defined in

client.ts:680

listIdentities

▸ listIdentities(realmName, max, next): ListIdentitiesResult

Set up the pagination result for listing identities

Each page is returned when the next() function is invoked on the ListIdentitiesResult object.

example

const realmName = 'westeros'
// list identities in westeros 10 at a time
const idList = accountClient.listIdentities(realmName, 10)
// Must call idList.next() to receive results
while (!idList.done) {
   const identities = await idList.next()
   for (let identity of identities) {
       console.log(identity.username)
   }
}

Note: If the value of max is higher than the maximum allowed by the server, idList.next() will only return up to the number of identities allowed by the server

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`max`	`number`	The maximum number of identities per page. Up to the max allowed by the server.
`next`	`number`	The next token, used for paging. Default is 0.

Returns

ListIdentitiesResult

A object usable for making paginated queries.

Defined in

client.ts:1142

listRealmApplicationRoles

▸ listRealmApplicationRoles(realmName, applicationId): Promise<Role[]>

Lists all realm application roles for a realm.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`applicationId`	`string`	Id of client application.

Returns

Promise<Role[]>

List of all roles for application.

Defined in

client.ts:661

listRealmGroups

▸ listRealmGroups(realmName): Promise<Group[]>

Lists all realm groups for a realm.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.

Returns

Promise<Group[]>

List of all groups at realm.

Defined in

client.ts:467

listRealmRoles

▸ listRealmRoles(realmName): Promise<Role[]>

Lists all realm roles for a realm.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.

Returns

Promise<Role[]>

List of all roles at realm.

Defined in

client.ts:557

listRealms

▸ listRealms(): Promise<Realms>

Lists all Realms belonging to the account.

Returns

Promise<Realms>

The listed realm representations returned by the server.

Defined in

client.ts:357

newRegistrationToken

▸ newRegistrationToken(name, permissions?, totalUsesAllowed): Promise<RegistrationToken>

Create a new registration token for the account.

Parameters

Name	Type	Description
`name`	`string`	The user defined name for the new token. Not unique.
`permissions`	`object`	A set of key-value pair of permissions for the token.
`totalUsesAllowed`	`number`	The number of uses the token is allowed. If not set, unlimited uses are allowed.

Returns

Promise<RegistrationToken>

The created registration token.

Defined in

client.ts:230

newWebhook

▸ newWebhook(webhook_url, triggers): Promise<Webhook>

Create a new webhook for the account.

Parameters

Name	Type	Description
`webhook_url`	`string`	The payload url
`triggers`	`object`	A list of triggers to associate with the webhook not set, unlimited uses are allowed.

Returns

Promise<Webhook>

The created webhook.

Defined in

client.ts:267

refreshProfile

▸ refreshProfile(): Promise<void>

refreshProfile users internal logic in the api token refresher to update the user's profile info from the backend. Currently, this is used to allow a user to verify their email, hit refresh in an already open window, and continue with an updated accountClient on the frontend.

This will likely be replaced by a call to GET the account profile.

Returns

Promise<void>

Defined in

client.ts:1204

registerIdentity

▸ registerIdentity(realmName, registrationToken, identity): Promise<Identity>

Registers an identity with the specified realm using the specified parameters,returning the created identity and error (if any).

Note that the identity input takes snake_case values.

registerIdentity() is intended for internal use. The JS SDK (@toznysecure/sdk/node) should be used instead to register Identities.

Note that no notes are written in this method, so the broker Identity is unable to perform password recovery for Identities registered with this method. The Identity will be unable to login to the Realm as a result.

example

// Create a token
const token = await accountClient.newRegistrationToken(tokenName, permissions)
const identity = {
  name: 'identityName',
  email: 'identity@example.com',
  first_name: 'firstName',
  last_name: 'lastName',
}
// Register Identity
const identityResponse = await accountClient.registerIdentity(
  realmName,
  token.token,
  identity
)

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`registrationToken`	`string`	the token for the realm
`identity`	`any`	Configuration for the new identity

Returns

Promise<Identity>

Defined in

client.ts:1003

registerRealmBrokerIdentity

▸ registerRealmBrokerIdentity(realmName, registrationToken): Promise<Identity>

registerRealmBrokerIdentity registers an identity to be the broker for a realm.

Parameters

Name	Type	Description
`realmName`	`string`	The name of the realm to register the broker identity with.
`registrationToken`	`string`	A registration for the account that has permissions for registering clients of type broker.

Returns

Promise<Identity>

The broker identity for the realm.

Defined in

client.ts:1073

registerTotp

▸ registerTotp(data): Promise<any>

Register Totp.

Parameters

Name	Type
`data`	`any`

Returns

Promise<any>

response

Defined in

client.ts:1431

registerWebAuthnDevice

▸ registerWebAuthnDevice(data): Promise<Response>

Parameters

Name	Type
`data`	`any`

Returns

Promise<Response>

Defined in

client.ts:1456

registrationTokens

▸ registrationTokens(): Promise<RegistrationToken[]>

Get a list of the current registration tokens for an account.

Returns

Promise<RegistrationToken[]>

Defined in

client.ts:217

removeDefaultRealmGroups

▸ removeDefaultRealmGroups(realmName, groups): Promise<boolean>

Remove groups for the request realm. note: when default realm groups are changed existing users' groups are not updated

example

const toznyEngineersGroup = await client.createRealmGroup(realmName, {
  name: 'ToznyEngineers',
})
await client.addDefaultRealmGroups(realmName, {
  groups: [toznyEngineersGroup.id],
})
await client.removeDefaultRealmGroups(realmName, {
  groups: [toznyEngineersGroup.id],
})

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groups`	`GroupsInput`	List of groups or group ids in an object on the `groups` key

Returns

Promise<boolean>

True if successful

Defined in

client.ts:959

removeGroupRoleMappings

▸ removeGroupRoleMappings(realmName, groupId, groupRoleMapping): Promise<boolean>

Removes a set of realm/client roles from a group's role mapping.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupId`	`string`	Id of realm group.
`groupRoleMapping`	`GroupRoleMapping`	The map of roles to remove to group's mapping.

Returns

Promise<boolean>

True if successful

Defined in

client.ts:739

replaceDefaultRealmGroups

▸ replaceDefaultRealmGroups(realmName, groups): Promise<boolean>

Replace default groups for the request realm. note: when default realm groups are changed existing users' groups are not updated

example

const toznyEngineersGroup = await client.createRealmGroup(realmName, {
  name: 'ToznyEngineers',
})
await client.replaceDefaultRealmGroups(realmName, {
  groups: [toznyEngineersGroup.id],
})

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groups`	`GroupsInput`	List of groups or group ids to leave in an object on the `groups` key

Returns

Promise<boolean>

True if successful

Defined in

client.ts:905

resendVerificationEmail

▸ resendVerificationEmail(): Promise<any>

Requests Tozny account email verification be resent.

Returns

Promise<any>

Defined in

client.ts:1213

serialize

▸ serialize(): Object

Returns

Object

Name	Type
`account`	`Account`
`api`	`Object`
`api.apiUrl`	`string`
`profile`	`any`
`storageClient`	`any`

Defined in

client.ts:1408

setClientEnabled

▸ setClientEnabled(clientId, enabled): Promise<boolean>

Parameters

Name	Type
`clientId`	`string`
`enabled`	`boolean`

Returns

Promise<boolean>

Defined in

client.ts:197

subscribe

▸ subscribe(): Promise<any>

Returns

Promise<any>

Defined in

client.ts:175

unsubscribe

▸ unsubscribe(): Promise<any>

Returns

Promise<any>

Defined in

client.ts:179

updateAccountBilling

▸ updateAccountBilling(stripeToken): Promise<any>

Parameters

Name	Type
`stripeToken`	`any`

Returns

Promise<any>

Defined in

client.ts:166

updateGroupMembership

▸ updateGroupMembership(realmName, identityToznyId, groups): Promise<boolean>

Update group membership

example

const identity = await accountClient.identityDetails(realmName, username)
const toznyEngineersGroup = await client.createRealmGroup(realmName, {
  name: 'ToznyEngineers',
})
await client.updateGroupMembership(realmName, identity.toznyId, {
  groups: [toznyEngineersGroup.id],
})

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`identityToznyId`	`string`	Id of Tozny identity
`groups`	`GroupsInput`	List of groups or group ids to update in an object on the `groups` key

Returns

Promise<boolean>

True if successful

Defined in

client.ts:793

updateProfile

▸ updateProfile(profile): Promise<any>

Allows user to update the name and email on their account. Profile param contains a name and email for the user.

Parameters

Name	Type
`profile`	`Object`
`profile.email`	`string`
`profile.name`	`string`

Returns

Promise<any>

Defined in

client.ts:206

updateRealmApplicationRole

▸ updateRealmApplicationRole(realmName, applicationId, originalRoleName, role): Promise<Role>

Update an existing application role in the realm given the original role name.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`applicationId`	`string`	Id of client application.
`originalRoleName`	`string`	Name of the role being updated.
`role`	`MinimumRoleWithId`	Updated attributes of the role.

Returns

Promise<Role>

Defined in

client.ts:596

updateRealmGroup

▸ updateRealmGroup(realmName, groupId, group): Promise<Group>

Update an existing group in the realm given a group id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupId`	`string`	Id of group to update.
`group`	`Group`	Updated attributes of the group

Returns

Promise<Group>

Defined in

client.ts:447

updateRealmRole

▸ updateRealmRole(realmName, role): Promise<Role>

Update an existing role in the realm given a role id.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`role`	`MinimumRoleWithId`	Updated attributes of the role.

Returns

Promise<Role>

The updated role

Defined in

client.ts:517

updateRealmSettings

▸ updateRealmSettings(realmName, settings): Promise<RealmSettings>

Updates settings for the realm. Some of these features enabled by these settings are experimental and may be subject to change.

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`settings`	`RealmSettings`	Object containing settings to enable.

Returns

Promise<RealmSettings>

Updated realm settings.

Defined in

client.ts:396

upsertAccessPoliciesForGroup

▸ upsertAccessPoliciesForGroup(realmName, groupId, accessPolicies): Promise<GroupAccessPolicies>

Create, update, or remove an Access Policy for a Group

This method is built to handle attaching multiple policies to a single group. However, currently only one policy per group is supported.

example

const realmName = 'westeros'
const groupId = '12345678-90ab-cdef-0000-000000000000'
const approvalRole = await accountClient.createRealmRole(
  realmName,
  { name: "NightsWatch", description: "They guard the wall." }
);

// create a new policy for group.
// a request for access must be approved by one user with `approvalRole`
// upon approval, access is granted for 1 day
let groupAccessPolicy = await accountClient.upsertAccessPoliciesForGroup(
  realmName,
  groupId,
  [{ approvalRoles: [approvalRole], requiredApprovals: 1, maxAccessDurationSeconds: 24*3600 }]
)
groupAccessPolicy.id === groupId //=> true
const accessPolicy = groupAccessPolicy.accessPolicies[0]

// update approval roles of existing policy
const anotherRole = await accountClient.describeRealmRole(realmName, roleId)
groupAccessPolicy = await accountClient.upsertAccessPoliciesForGroup(
  realmName,
  groupId,
  [{
    id: accessPolicy.id, //<-- updating the existing policy.
    approvalRoles: [approvalRole, anotherRole],
    requiredApprovals: 1,
    maxAccessDurationSeconds: 24*3600,
  }]
)

// remove access policy by setting policies to empty array
groupAccessPolicy = await accountClient.upsertAccessPoliciesForGroup(
  realmName,
  groupId,
  [] // <-- the group will no longer be governed by any access policy
)

Parameters

Name	Type	Description
`realmName`	`string`	Name of realm.
`groupId`	`string`	The ID of the Group in Tozny
`accessPolicies`	`AccessPolicyData`[]	Configuration for the new identity

Returns

Promise<GroupAccessPolicies>

Object containing groups id & accessPolicies

Defined in

client.ts:1331

validatePassword

▸ validatePassword(password): Promise<boolean>

Parameters

Name	Type
`password`	`string`

Returns

Promise<boolean>

Defined in

client.ts:80

webhooks

▸ webhooks(): Promise<Webhook[]>

Get a list of the current webhooks for an account.

Returns

Promise<Webhook[]>

Defined in

client.ts:254

Files

Client.md

Latest commit

History

Client.md

File metadata and controls

Class: Client

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Defined in

Properties

account

Defined in

profile

Defined in

Accessors

queenClient

Returns

Defined in

Methods

addBillingCoupon

Parameters

Returns

Defined in

addDefaultRealmGroups

Parameters

Returns

Defined in

addGroupRoleMappings

Parameters

Returns

Defined in

addRolesToIdentity

Parameters

Returns

Defined in

billingStatus

Returns

Defined in

changePassword

Parameters

Returns

Defined in

createRealm

Parameters

Returns

Defined in

createRealmApplicationRole

Parameters

Returns

Defined in

createRealmGroup

Parameters

Returns

Defined in

createRealmRole

Parameters

Returns

Defined in

deleteIdentity

Parameters

Returns

Defined in

deleteMFA

Parameters

Returns

Defined in

deleteRealm

Parameters

Returns

Defined in

deleteRealmApplicationRole

Parameters

Returns