Skip to content

arlas-wui-toolkit / Exports / ArlasIamApi

Class: ArlasIamApi

Hierarchy

  • DefaultApi

ArlasIamApi

Table of contents

Constructors

Properties

Methods

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:168

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

activateUser

activateUser(id, options?): Promise<ArlasMessage>

Summary

Activate the given user

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.activateUser

Defined in

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


addColumnFilterPermission

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

Summary

Add column filter permission for the given collections.

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<PermissionData>

Inherited from

DefaultApi.addColumnFilterPermission

Defined in

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


addForbiddenOrganisation

addForbiddenOrganisation(body, options?): Promise<ForbiddenOrganisation>

Summary

Add a name to the forbidden organisations list.

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ForbiddenOrganisation>

Inherited from

DefaultApi.addForbiddenOrganisation

Defined in

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


addGroupToOrganisation

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

Summary

Add a group to an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<RoleData>

Inherited from

DefaultApi.addGroupToOrganisation

Defined in

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


addPermission

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

Summary

Add a permission

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<PermissionData>

Inherited from

DefaultApi.addPermission

Defined in

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


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:1126


addRoleToOrganisation

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

Summary

Add a role to an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<RoleData>

Inherited from

DefaultApi.addRoleToOrganisation

Defined in

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


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:1147


addUserToOrganisation

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

Summary

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

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<OrgData>

Inherited from

DefaultApi.addUserToOrganisation

Defined in

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


askPasswordReset

askPasswordReset(body, options?): Promise<ArlasMessage>

Summary

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

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.askPasswordReset

Defined in

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


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:1174


createApiKey

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

Summary

Create an API Key

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ApiKey>

Inherited from

DefaultApi.createApiKey

Defined in

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


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:1193


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:1202


createUser

createUser(body, options?): Promise<UserData>

Summary

Create a user

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<UserData>

Inherited from

DefaultApi.createUser

Defined in

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


deactivateUser

deactivateUser(id, options?): Promise<ArlasMessage>

Summary

Deactivate the given user

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.deactivateUser

Defined in

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


deleteApiKey

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

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<ArlasMessage>

Inherited from

DefaultApi.deleteApiKey

Defined in

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


deleteGroupInOrganisation

deleteGroupInOrganisation(oid, rid, options?): Promise<ArlasMessage>

Summary

Delete a group from an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.deleteGroupInOrganisation

Defined in

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


deleteOrganisation

deleteOrganisation(oid, options?): Promise<ArlasMessage>

Summary

Delete an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.deleteOrganisation

Defined in

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


deletePermission

deletePermission(oid, pid, options?): Promise<ArlasMessage>

Summary

Delete a permission

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.deletePermission

Defined in

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


deleteUser

deleteUser(id, options?): Promise<ArlasMessage>

Summary

Delete the given user

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.deleteUser

Defined in

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


forwardAuth

forwardAuth(options?): Promise<ArlasMessage>

Summary

Validate authentication to another URI

Throws

Memberof

DefaultApi

Parameters

Name Type Description
options? any Override http request option.

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.forwardAuth

Defined in

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


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:1287


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:1296


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:1306


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:1315


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:1324


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:1332


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:1341


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:1351


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:1360


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:1370


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:1379


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:1389


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:1399


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:1407


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:1417


login

login(body, options?): Promise<LoginData>

Summary

User login

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<LoginData>

Inherited from

DefaultApi.login

Defined in

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


logout

logout(options?): Promise<ArlasMessage>

Summary

Delete session

Throws

Memberof

DefaultApi

Parameters

Name Type Description
options? any Override http request option.

Returns

Promise<ArlasMessage>

Inherited from

DefaultApi.logout

Defined in

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


putRoles

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

Summary

Modify roles of a user within an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<UserData>

Inherited from

DefaultApi.putRoles

Defined in

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


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:1454


refresh

refresh(options?): Promise<LoginData>

Summary

Refresh access token

Throws

Memberof

DefaultApi

Parameters

Name Type Description
options? any Override http request option.

Returns

Promise<LoginData>

Inherited from

DefaultApi.refresh

Defined in

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


removeNameFromForbiddenOrganisation

removeNameFromForbiddenOrganisation(name, options?): Promise<ArlasMessage>

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<ArlasMessage>

Inherited from

DefaultApi.removeNameFromForbiddenOrganisation

Defined in

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


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:1482


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:1493


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:1503


resetUserPassword

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

Summary

Reset user password (through link received by email)

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<UserData>

Inherited from

DefaultApi.resetUserPassword

Defined in

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


updateColumnFilterPermission

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

Summary

Update a column filter permission.

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<PermissionData>

Inherited from

DefaultApi.updateColumnFilterPermission

Defined in

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


updateGroupInOrganisation

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

Summary

Update a role's group in an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<RoleData>

Inherited from

DefaultApi.updateGroupInOrganisation

Defined in

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


updatePermission

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

Summary

Update a permission

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<PermissionData>

Inherited from

DefaultApi.updatePermission

Defined in

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


updatePermissionOfRole

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

Summary

Update permissions of a role

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<RoleData>

Inherited from

DefaultApi.updatePermissionOfRole

Defined in

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


updateRoleInOrganisation

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

Summary

Update a role in an organisation

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<RoleData>

Inherited from

DefaultApi.updateRoleInOrganisation

Defined in

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


updateUser

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

Summary

Update the given user (absent attribute - null - are not updated).

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<UserData>

Inherited from

DefaultApi.updateUser

Defined in

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


verifyUser

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

Summary

Verify a user (through link received by email)

Throws

Memberof

DefaultApi

Parameters

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

Returns

Promise<UserData>

Inherited from

DefaultApi.verifyUser

Defined in

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