arlas-wui-toolkit / Exports / ArlasIamApi

Class: ArlasIamApi

Hierarchy

• DefaultApi

↳ ArlasIamApi

Table of contents

Constructors

• constructor

Properties

• basePath
• configuration
• fetch

Methods

• addColumnFilterPermission
• addForbiddenOrganisation
• addGroupToOrganisation
• addPermission
• addPermissionToRole
• addRoleToOrganisation
• addRoleToUserInOrganisation
• addUserToOrganisation
• askPasswordReset
• checkOrganisation
• createApiKey
• createOrganisation
• createOrganisationWithName
• createUser
• deleteApiKey
• deleteOrganisation
• deleteUser
• forwardAuth
• getCollectionsOfColumnFiltersInOrganisation
• getEmails
• getGroups
• getGroupsOfOrganisation
• getOrganisationCollections
• getOrganisations
• getPermissionToken
• getPermissions
• getPermissionsOfOrganisation
• getRoles
• getRolesOfOrganisation
• getUser
• getUsers
• listForbiddenOrganisations
• listPermissionOfRole
• login
• logout
• putRoles
• readUser
• refresh
• removeNameFromForbiddenOrganisation
• removePermissionFromRole
• removeRoleFromUserInOrganisation
• removeUserFromOrganisation
• resetUserPassword
• updateColumnFilterPermission
• updateGroupInOrganisation
• updatePermission
• updatePermissionOfRole
• updateRoleInOrganisation
• updateUser
• verifyUser

Constructors

constructor

• new ArlasIamApi(conf, basePath, fetch)

Parameters

Name	Type
conf	Configuration
basePath	string
fetch	any

Overrides

DefaultApi.constructor

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:96

Properties

basePath

• Protected basePath: string

Inherited from

DefaultApi.basePath

Defined in

node_modules/arlas-iam-api/api.d.ts:36

---

configuration

• Protected configuration: Configuration

Inherited from

DefaultApi.configuration

Defined in

node_modules/arlas-iam-api/api.d.ts:38

---

fetch

• Protected fetch: FetchAPI

Inherited from

DefaultApi.fetch

Defined in

node_modules/arlas-iam-api/api.d.ts:37

Methods

addColumnFilterPermission

▸ addColumnFilterPermission(oid, collections, options?): Promise<PermissionData>

Summary

Add column filter permission for the given collections.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
collections	string[]
options?	any	Override http request option.

Returns

Promise<PermissionData>

Inherited from

DefaultApi.addColumnFilterPermission

Defined in

node_modules/arlas-iam-api/api.d.ts:1053

---

addForbiddenOrganisation

▸ addForbiddenOrganisation(forbiddenOrganisation, options?): Promise<ForbiddenOrganisation>

Summary

Add a name to the forbidden organisations list.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
forbiddenOrganisation	ForbiddenOrganisation
options?	any	Override http request option.

Returns

Promise<ForbiddenOrganisation>

Inherited from

DefaultApi.addForbiddenOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1062

---

addGroupToOrganisation

▸ addGroupToOrganisation(oid, roleDef, options?): Promise<RoleData>

Summary

Add a group to an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
roleDef	RoleDef
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.addGroupToOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1072

---

addPermission

▸ addPermission(oid, permission, options?): Promise<PermissionData>

Summary

Add a permission

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
permission	PermissionDef
options?	any	Override http request option.

Returns

Promise<PermissionData>

Inherited from

DefaultApi.addPermission

Defined in

node_modules/arlas-iam-api/api.d.ts:1082

---

addPermissionToRole

▸ addPermissionToRole(oid, rid, pid, options?): Promise<RoleData>

Summary

Add a permission to a role

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rid	string
pid	string
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.addPermissionToRole

Defined in

node_modules/arlas-iam-api/api.d.ts:1093

---

addRoleToOrganisation

▸ addRoleToOrganisation(oid, roleDef, options?): Promise<RoleData>

Summary

Add a role to an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
roleDef	RoleDef
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.addRoleToOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1103

---

addRoleToUserInOrganisation

▸ addRoleToUserInOrganisation(oid, uid, rid, options?): Promise<UserData>

Summary

Add a role to a user in an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
rid	string
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.addRoleToUserInOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1114

---

addUserToOrganisation

▸ addUserToOrganisation(oid, user, options?): Promise<OrgData>

Summary

Add a user to an organisation. User account will be created if needed.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
user	OrgUserDef
options?	any	Override http request option.

Returns

Promise<OrgData>

Inherited from

DefaultApi.addUserToOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1124

---

askPasswordReset

▸ askPasswordReset(email, options?): Promise<string>

Summary

Request a password modification if forgotten (send email with link).

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
email	string
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.askPasswordReset

Defined in

node_modules/arlas-iam-api/api.d.ts:1133

---

checkOrganisation

▸ checkOrganisation(options?): Promise<OrgExists>

Summary

Check if user's organisation exists

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
options?	any	Override http request option.

Returns

Promise<OrgExists>

Inherited from

DefaultApi.checkOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1141

---

createApiKey

▸ createApiKey(oid, uid, apiKeyDef, options?): Promise<ApiKey>

Summary

Create an API Key

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
apiKeyDef	ApiKeyDef
options?	any	Override http request option.

Returns

Promise<ApiKey>

Inherited from

DefaultApi.createApiKey

Defined in

node_modules/arlas-iam-api/api.d.ts:1152

---

createOrganisation

▸ createOrganisation(options?): Promise<OrgData>

Summary

Create an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
options?	any	Override http request option.

Returns

Promise<OrgData>

Inherited from

DefaultApi.createOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1160

---

createOrganisationWithName

▸ createOrganisationWithName(name, options?): Promise<OrgData>

Summary

Create an organisation with a name. Only for IAM admin.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
name	string
options?	any	Override http request option.

Returns

Promise<OrgData>

Inherited from

DefaultApi.createOrganisationWithName

Defined in

node_modules/arlas-iam-api/api.d.ts:1169

---

createUser

▸ createUser(userDef, options?): Promise<UserData>

Summary

Create a user

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
userDef	NewUserDef
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.createUser

Defined in

node_modules/arlas-iam-api/api.d.ts:1178

---

deleteApiKey

▸ deleteApiKey(oid, uid, kid, options?): Promise<string>

Summary

Delete an API Key

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
kid	string
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.deleteApiKey

Defined in

node_modules/arlas-iam-api/api.d.ts:1189

---

deleteOrganisation

▸ deleteOrganisation(oid, options?): Promise<string>

Summary

Delete an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.deleteOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1198

---

deleteUser

▸ deleteUser(id, options?): Promise<string>

Summary

Delete the logged in user

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
id	string
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.deleteUser

Defined in

node_modules/arlas-iam-api/api.d.ts:1207

---

forwardAuth

▸ forwardAuth(options?): Promise<string>

Summary

Validate authentication to another URI

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.forwardAuth

Defined in

node_modules/arlas-iam-api/api.d.ts:1215

---

getCollectionsOfColumnFiltersInOrganisation

▸ getCollectionsOfColumnFiltersInOrganisation(oid, pid, options?): Promise<string[]>

Summary

List collections of a column filter of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
pid	string
options?	any	Override http request option.

Returns

Promise<string[]>

Inherited from

DefaultApi.getCollectionsOfColumnFiltersInOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1225

---

getEmails

▸ getEmails(oid, options?): Promise<string[]>

Summary

List users of same domain than the organisation but not invited yet.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
options?	any	Override http request option.

Returns

Promise<string[]>

Inherited from

DefaultApi.getEmails

Defined in

node_modules/arlas-iam-api/api.d.ts:1234

---

getGroups

▸ getGroups(oid, uid, options?): Promise<RoleData[]>

Summary

List groups of a user within an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
options?	any	Override http request option.

Returns

Promise<RoleData[]>

Inherited from

DefaultApi.getGroups

Defined in

node_modules/arlas-iam-api/api.d.ts:1244

---

getGroupsOfOrganisation

▸ getGroupsOfOrganisation(oid, options?): Promise<RoleData[]>

Summary

List groups of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
options?	any	Override http request option.

Returns

Promise<RoleData[]>

Inherited from

DefaultApi.getGroupsOfOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1253

---

getOrganisationCollections

▸ getOrganisationCollections(oid, options?): Promise<string[]>

Summary

List collections of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
options?	any	Override http request option.

Returns

Promise<string[]>

Inherited from

DefaultApi.getOrganisationCollections

Defined in

node_modules/arlas-iam-api/api.d.ts:1262

---

getOrganisations

▸ getOrganisations(options?): Promise<UserOrgData[]>

Summary

List organisations of the logged in user

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
options?	any	Override http request option.

Returns

Promise<UserOrgData[]>

Inherited from

DefaultApi.getOrganisations

Defined in

node_modules/arlas-iam-api/api.d.ts:1270

---

getPermissionToken

▸ getPermissionToken(arlas_org_filter?, options?): Promise<string>

Summary

Get permissions for a user given access token

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
arlas_org_filter?	string
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.getPermissionToken

Defined in

node_modules/arlas-iam-api/api.d.ts:1279

---

getPermissions

▸ getPermissions(oid, uid, options?): Promise<PermissionData[]>

Summary

List permissions of a user within an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
options?	any	Override http request option.

Returns

Promise<PermissionData[]>

Inherited from

DefaultApi.getPermissions

Defined in

node_modules/arlas-iam-api/api.d.ts:1289

---

getPermissionsOfOrganisation

▸ getPermissionsOfOrganisation(oid, options?): Promise<PermissionData[]>

Summary

List permissions of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
options?	any	Override http request option.

Returns

Promise<PermissionData[]>

Inherited from

DefaultApi.getPermissionsOfOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1298

---

getRoles

▸ getRoles(oid, uid, options?): Promise<RoleData[]>

Summary

List roles of a user within an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
options?	any	Override http request option.

Returns

Promise<RoleData[]>

Inherited from

DefaultApi.getRoles

Defined in

node_modules/arlas-iam-api/api.d.ts:1308

---

getRolesOfOrganisation

▸ getRolesOfOrganisation(oid, options?): Promise<RoleData[]>

Summary

List roles of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
options?	any	Override http request option.

Returns

Promise<RoleData[]>

Inherited from

DefaultApi.getRolesOfOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1317

---

getUser

▸ getUser(oid, uid, options?): Promise<MemberData>

Summary

Get a user of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
options?	any	Override http request option.

Returns

Promise<MemberData>

Inherited from

DefaultApi.getUser

Defined in

node_modules/arlas-iam-api/api.d.ts:1327

---

getUsers

▸ getUsers(oid, rname?, options?): Promise<MemberData[]>

Summary

List users of an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rname?	string
options?	any	Override http request option.

Returns

Promise<MemberData[]>

Inherited from

DefaultApi.getUsers

Defined in

node_modules/arlas-iam-api/api.d.ts:1337

---

listForbiddenOrganisations

▸ listForbiddenOrganisations(options?): Promise<ForbiddenOrganisation[]>

Summary

List forbidden organisations.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
options?	any	Override http request option.

Returns

Promise<ForbiddenOrganisation[]>

Inherited from

DefaultApi.listForbiddenOrganisations

Defined in

node_modules/arlas-iam-api/api.d.ts:1345

---

listPermissionOfRole

▸ listPermissionOfRole(oid, rid, options?): Promise<PermissionData[]>

Summary

List permissions of a role

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rid	string
options?	any	Override http request option.

Returns

Promise<PermissionData[]>

Inherited from

DefaultApi.listPermissionOfRole

Defined in

node_modules/arlas-iam-api/api.d.ts:1355

---

login

▸ login(loginDef, options?): Promise<LoginData>

Summary

User login

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
loginDef	LoginDef
options?	any	Override http request option.

Returns

Promise<LoginData>

Inherited from

DefaultApi.login

Defined in

node_modules/arlas-iam-api/api.d.ts:1364

---

logout

▸ logout(options?): Promise<string>

Summary

Delete session

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.logout

Defined in

node_modules/arlas-iam-api/api.d.ts:1372

---

putRoles

▸ putRoles(oid, uid, ridList, options?): Promise<UserData>

Summary

Modify roles of a user within an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
ridList	UpdateListDef
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.putRoles

Defined in

node_modules/arlas-iam-api/api.d.ts:1383

---

readUser

▸ readUser(id, options?): Promise<UserData>

Summary

Read a user

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
id	string
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.readUser

Defined in

node_modules/arlas-iam-api/api.d.ts:1392

---

refresh

▸ refresh(refreshToken, options?): Promise<LoginData>

Summary

Refresh access token

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
refreshToken	string
options?	any	Override http request option.

Returns

Promise<LoginData>

Inherited from

DefaultApi.refresh

Defined in

node_modules/arlas-iam-api/api.d.ts:1401

---

removeNameFromForbiddenOrganisation

▸ removeNameFromForbiddenOrganisation(name, options?): Promise<string>

Summary

Remove a name from the forbidden organisations list.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
name	string
options?	any	Override http request option.

Returns

Promise<string>

Inherited from

DefaultApi.removeNameFromForbiddenOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1410

---

removePermissionFromRole

▸ removePermissionFromRole(oid, rid, pid, options?): Promise<RoleData>

Summary

Remove a permission from a role

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rid	string
pid	string
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.removePermissionFromRole

Defined in

node_modules/arlas-iam-api/api.d.ts:1421

---

removeRoleFromUserInOrganisation

▸ removeRoleFromUserInOrganisation(oid, uid, rid, options?): Promise<UserData>

Summary

Remove a role from a user from an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
rid	string
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.removeRoleFromUserInOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1432

---

removeUserFromOrganisation

▸ removeUserFromOrganisation(oid, uid, options?): Promise<OrgData>

Summary

Remove a user from an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
uid	string
options?	any	Override http request option.

Returns

Promise<OrgData>

Inherited from

DefaultApi.removeUserFromOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1442

---

resetUserPassword

▸ resetUserPassword(id, token, password, options?): Promise<UserData>

Summary

Reset user password (through link received by email)

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
id	string
token	string
password	string
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.resetUserPassword

Defined in

node_modules/arlas-iam-api/api.d.ts:1453

---

updateColumnFilterPermission

▸ updateColumnFilterPermission(oid, pid, collections, options?): Promise<PermissionData>

Summary

Update a column filter permission.

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
pid	string
collections	string[]
options?	any	Override http request option.

Returns

Promise<PermissionData>

Inherited from

DefaultApi.updateColumnFilterPermission

Defined in

node_modules/arlas-iam-api/api.d.ts:1464

---

updateGroupInOrganisation

▸ updateGroupInOrganisation(oid, rid, roleDef, options?): Promise<RoleData>

Summary

Update a role's group in an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rid	string
roleDef	RoleDef
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.updateGroupInOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1475

---

updatePermission

▸ updatePermission(oid, pid, permission, options?): Promise<PermissionData>

Summary

Update a permission

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
pid	string
permission	PermissionDef
options?	any	Override http request option.

Returns

Promise<PermissionData>

Inherited from

DefaultApi.updatePermission

Defined in

node_modules/arlas-iam-api/api.d.ts:1486

---

updatePermissionOfRole

▸ updatePermissionOfRole(oid, rid, pidList, options?): Promise<RoleData>

Summary

Update permissions of a role

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rid	string
pidList	UpdateListDef
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.updatePermissionOfRole

Defined in

node_modules/arlas-iam-api/api.d.ts:1497

---

updateRoleInOrganisation

▸ updateRoleInOrganisation(oid, rid, roleDef, options?): Promise<RoleData>

Summary

Update a role in an organisation

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
oid	string
rid	string
roleDef	RoleDef
options?	any	Override http request option.

Returns

Promise<RoleData>

Inherited from

DefaultApi.updateRoleInOrganisation

Defined in

node_modules/arlas-iam-api/api.d.ts:1508

---

updateUser

▸ updateUser(id, updateDef, options?): Promise<UserData>

Summary

Update the logged in user

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
id	string
updateDef	UpdateUserDef
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.updateUser

Defined in

node_modules/arlas-iam-api/api.d.ts:1518

---

verifyUser

▸ verifyUser(id, token, password, options?): Promise<UserData>

Summary

Verify a user (through link received by email)

Throws

Memberof

DefaultApi

Parameters

Name	Type	Description
id	string
token	string
password	string
options?	any	Override http request option.

Returns

Promise<UserData>

Inherited from

DefaultApi.verifyUser

Defined in

node_modules/arlas-iam-api/api.d.ts:1529