Reference

BackstageClient.users

BackstageClient.users in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / users

users: {
  addRole: (usrId: string, request: {
     accountId: string;
     roleId: string;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     id: string;
     organisationId: string;
     roleId: string;
     userId: string;
  }>;
  create: (request: {
     email: string;
     firstName?: string;
     lastName?: string;
     organisationId: string;
   }, requestOptions?: RequestOptions) => Promise<{
     invitation: {
        code: string;
        createdAt: string;
        email: string;
        expiresAt: string;
        id: string;
        organisationId: string;
        redeemedAt: string | null;
        userId: string;
     };
     user: {
        createdAt: string;
        email: string;
        externalUserId: string | null;
        firstName: string | null;
        id: string;
        identityProvider: string;
        lastName: string | null;
        organisationId: string;
        updatedAt: string;
     };
  }>;
  delete: (id: string, requestOptions?: RequestOptions) => Promise<{
     createdAt: string;
     email: string;
     externalUserId: string | null;
     firstName: string | null;
     id: string;
     identityProvider: string;
     lastName: string | null;
     organisationId: string;
     updatedAt: string;
  }>;
  get: (id: string, requestOptions?: RequestOptions) => Promise<{
     createdAt: string;
     email: string;
     externalUserId: string | null;
     firstName: string | null;
     id: string;
     identityProvider: string;
     lastName: string | null;
     organisationId: string;
     updatedAt: string;
  }>;
  list: (requestOptions?: RequestOptions) => Promise<{
     createdAt: string;
     email: string;
     externalUserId: string | null;
     firstName: string | null;
     id: string;
     identityProvider: string;
     lastName: string | null;
     organisationId: string;
     updatedAt: string;
  }[]>;
  removeRole: (usrId: string, rolId: string, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     id: string;
     organisationId: string;
     roleId: string;
     userId: string;
  }>;
  update: (id: string, request: {
     email?: string;
     firstName?: string;
     lastName?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     createdAt: string;
     email: string;
     externalUserId: string | null;
     firstName: string | null;
     id: string;
     identityProvider: string;
     lastName: string | null;
     organisationId: string;
     updatedAt: string;
  }>;
};

Defined in: client.ts:2107

Users methods

addRole()#

addRole: (usrId: string, request: {
  accountId: string;
  roleId: string;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  id: string;
  organisationId: string;
  roleId: string;
  userId: string;
}>;

Assign a role to a user Assigns a role to a user for one account. Requires roles.assign:all.

Parameters#

Parameter	Type
`usrId`	`string`
`request`	{ `accountId`: `string`; `roleId`: `string`; }
`request.accountId`	`string`
`request.roleId?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; id: string; organisationId: string; roleId: string; userId: string; }>

Operation Id#

addRoleToUser

create()#

create: (request: {
  email: string;
  firstName?: string;
  lastName?: string;
  organisationId: string;
}, requestOptions?: RequestOptions) => Promise<{
  invitation: {
     code: string;
     createdAt: string;
     email: string;
     expiresAt: string;
     id: string;
     organisationId: string;
     redeemedAt: string | null;
     userId: string;
  };
  user: {
     createdAt: string;
     email: string;
     externalUserId: string | null;
     firstName: string | null;
     id: string;
     identityProvider: string;
     lastName: string | null;
     organisationId: string;
     updatedAt: string;
  };
}>;

Create user Creates a user in the organisation and issues them an invitation. Requires users.create:all.

Parameters#

Parameter	Type
`request`	{ `email`: `string`; `firstName?`: `string`; `lastName?`: `string`; `organisationId`: `string`; }
`request.email`	`string`
`request.firstName?`	`string`
`request.lastName?`	`string`
`request.organisationId?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ invitation: { code: string; createdAt: string; email: string; expiresAt: string; id: string; organisationId: string; redeemedAt: string | null; userId: string; }; user: { createdAt: string; email: string; externalUserId: string | null; firstName: string | null; id: string; identityProvider: string; lastName: string | null; organisationId: string; updatedAt: string; }; }>

Operation Id#

createUser

delete()#

delete: (id: string, requestOptions?: RequestOptions) => Promise<{
  createdAt: string;
  email: string;
  externalUserId: string | null;
  firstName: string | null;
  id: string;
  identityProvider: string;
  lastName: string | null;
  organisationId: string;
  updatedAt: string;
}>;

Delete user Soft-deletes a user of the organisation. Requires users.delete:all.

Parameters#

Parameter	Type
`id`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ createdAt: string; email: string; externalUserId: string | null; firstName: string | null; id: string; identityProvider: string; lastName: string | null; organisationId: string; updatedAt: string; }>

Operation Id#

deleteUser

get()#

get: (id: string, requestOptions?: RequestOptions) => Promise<{
  createdAt: string;
  email: string;
  externalUserId: string | null;
  firstName: string | null;
  id: string;
  identityProvider: string;
  lastName: string | null;
  organisationId: string;
  updatedAt: string;
}>;

Get user Gets a user of the organisation by ID. Requires users.read:all.

Parameters#

Parameter	Type
`id`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

getUser

list()#

list: (requestOptions?: RequestOptions) => Promise<{
  createdAt: string;
  email: string;
  externalUserId: string | null;
  firstName: string | null;
  id: string;
  identityProvider: string;
  lastName: string | null;
  organisationId: string;
  updatedAt: string;
}[]>;

List users Lists the users of the organisation. Requires users.read:all.

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listUsers

removeRole()#

removeRole: (usrId: string, rolId: string, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  id: string;
  organisationId: string;
  roleId: string;
  userId: string;
}>;

Remove a role from a user Removes a role assignment from a user. Requires roles.assign:all.

Parameters#

Parameter	Type
`usrId`	`string`
`rolId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; id: string; organisationId: string; roleId: string; userId: string; }>

Operation Id#

removeRoleFromUser

update()#

update: (id: string, request: {
  email?: string;
  firstName?: string;
  lastName?: string;
}, requestOptions?: RequestOptions) => Promise<{
  createdAt: string;
  email: string;
  externalUserId: string | null;
  firstName: string | null;
  id: string;
  identityProvider: string;
  lastName: string | null;
  organisationId: string;
  updatedAt: string;
}>;

Update user Updates a user's name or email address. Requires users.update:all.

Parameters#

Parameter	Type
`id`	`string`
`request`	{ `email?`: `string`; `firstName?`: `string`; `lastName?`: `string`; }
`request.email?`	`string`
`request.firstName?`	`string`
`request.lastName?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

updateUser