arlas-iam-api/api.d.ts

IAM Arlas

/**
 * ARLAS IAM APIs
 * IAM REST services
 *
 * OpenAPI spec version: 28.0.2
 * Contact: contact@gisaia.com
 *
 * NOTE: This file is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the file manually.
 */
import { Configuration } from "./configuration.js";
/**
 *
 * @export
 */
export declare const COLLECTION_FORMATS: {
    csv: string;
    ssv: string;
    tsv: string;
    pipes: string;
};
/**
 *
 * @export
 * @interface FetchAPI
 */
export interface FetchAPI {
    (url: string, init?: any): Promise<Response>;
}
/**
 *
 * @export
 * @interface FetchArgs
 */
export interface FetchArgs {
    url: string;
    options: any;
}
/**
 *
 * @export
 * @class BaseAPI
 */
export declare class BaseAPI {
    protected basePath: string;
    protected fetch: FetchAPI;
    protected configuration: Configuration;
    constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
}
/**
 *
 * @export
 * @class RequiredError
 * @extends {Error}
 */
export declare class RequiredError extends Error {
    field: string;
    name: "RequiredError";
    constructor(field: string, msg?: string);
}
/**
 *
 * @export
 * @interface ApiKey
 */
export interface ApiKey {
    /**
     *
     * @type {string}
     * @memberof ApiKey
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof ApiKey
     */
    name?: string;
    /**
     *
     * @type {string}
     * @memberof ApiKey
     */
    key_id?: string;
    /**
     *
     * @type {string}
     * @memberof ApiKey
     */
    key_secret?: string;
    /**
     *
     * @type {Date}
     * @memberof ApiKey
     */
    creation_date?: Date;
    /**
     *
     * @type {number}
     * @memberof ApiKey
     */
    ttl_in_days?: number;
    /**
     *
     * @type {User}
     * @memberof ApiKey
     */
    owner?: User;
    /**
     *
     * @type {Organisation}
     * @memberof ApiKey
     */
    org?: Organisation;
    /**
     *
     * @type {Array<Role>}
     * @memberof ApiKey
     */
    roles?: Array<Role>;
}
/**
 *
 * @export
 * @interface ApiKeyDef
 */
export interface ApiKeyDef {
    /**
     *
     * @type {string}
     * @memberof ApiKeyDef
     */
    name?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof ApiKeyDef
     */
    roleIds?: Array<string>;
    /**
     *
     * @type {number}
     * @memberof ApiKeyDef
     */
    ttlInDays?: number;
}
/**
 *
 * @export
 * @interface ArlasMessage
 */
export interface ArlasMessage {
    /**
     *
     * @type {string}
     * @memberof ArlasMessage
     */
    message?: string;
}
/**
 *
 * @export
 * @interface ForbiddenOrganisation
 */
export interface ForbiddenOrganisation {
    /**
     *
     * @type {string}
     * @memberof ForbiddenOrganisation
     */
    name?: string;
}
/**
 *
 * @export
 * @interface LoginData
 */
export interface LoginData {
    /**
     *
     * @type {UserData}
     * @memberof LoginData
     */
    user?: UserData;
    /**
     *
     * @type {string}
     * @memberof LoginData
     */
    access_token?: string;
}
/**
 *
 * @export
 * @interface LoginDef
 */
export interface LoginDef {
    /**
     *
     * @type {string}
     * @memberof LoginDef
     */
    email?: string;
    /**
     *
     * @type {string}
     * @memberof LoginDef
     */
    password?: string;
}
/**
 *
 * @export
 * @interface MemberData
 */
export interface MemberData {
    /**
     *
     * @type {UserData}
     * @memberof MemberData
     */
    member?: UserData;
    /**
     *
     * @type {boolean}
     * @memberof MemberData
     */
    isOwner?: boolean;
}
/**
 *
 * @export
 * @interface ModelError
 */
export interface ModelError {
    /**
     *
     * @type {number}
     * @memberof ModelError
     */
    status?: number;
    /**
     *
     * @type {string}
     * @memberof ModelError
     */
    message?: string;
    /**
     *
     * @type {string}
     * @memberof ModelError
     */
    error?: string;
}
/**
 *
 * @export
 * @interface NewUserDef
 */
export interface NewUserDef {
    /**
     *
     * @type {string}
     * @memberof NewUserDef
     */
    email?: string;
    /**
     *
     * @type {string}
     * @memberof NewUserDef
     */
    locale?: string;
    /**
     *
     * @type {string}
     * @memberof NewUserDef
     */
    timezone?: string;
}
/**
 *
 * @export
 * @interface OrgData
 */
export interface OrgData {
    /**
     *
     * @type {string}
     * @memberof OrgData
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof OrgData
     */
    name?: string;
    /**
     *
     * @type {string}
     * @memberof OrgData
     */
    displayName?: string;
    /**
     *
     * @type {Array<MemberData>}
     * @memberof OrgData
     */
    members?: Array<MemberData>;
}
/**
 *
 * @export
 * @interface OrgExists
 */
export interface OrgExists {
    /**
     *
     * @type {boolean}
     * @memberof OrgExists
     */
    exists?: boolean;
}
/**
 *
 * @export
 * @interface OrgUserDef
 */
export interface OrgUserDef {
    /**
     *
     * @type {string}
     * @memberof OrgUserDef
     */
    email?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof OrgUserDef
     */
    rids?: Array<string>;
}
/**
 *
 * @export
 * @interface Organisation
 */
export interface Organisation {
    /**
     *
     * @type {string}
     * @memberof Organisation
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof Organisation
     */
    name?: string;
    /**
     *
     * @type {string}
     * @memberof Organisation
     */
    display_name?: string;
    /**
     *
     * @type {Array<OrganisationMember>}
     * @memberof Organisation
     */
    members?: Array<OrganisationMember>;
    /**
     *
     * @type {Array<Permission>}
     * @memberof Organisation
     */
    permissions?: Array<Permission>;
    /**
     *
     * @type {Array<Role>}
     * @memberof Organisation
     */
    roles?: Array<Role>;
}
/**
 *
 * @export
 * @interface OrganisationMember
 */
export interface OrganisationMember {
    /**
     *
     * @type {boolean}
     * @memberof OrganisationMember
     */
    owner?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof OrganisationMember
     */
    admin?: boolean;
    /**
     *
     * @type {User}
     * @memberof OrganisationMember
     */
    user?: User;
    /**
     *
     * @type {Organisation}
     * @memberof OrganisationMember
     */
    organisation?: Organisation;
}
/**
 *
 * @export
 * @interface Permission
 */
export interface Permission {
    /**
     *
     * @type {string}
     * @memberof Permission
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof Permission
     */
    value: string;
    /**
     *
     * @type {string}
     * @memberof Permission
     */
    description?: string;
    /**
     *
     * @type {Array<Role>}
     * @memberof Permission
     */
    roles?: Array<Role>;
    /**
     *
     * @type {Organisation}
     * @memberof Permission
     */
    organisation?: Organisation;
}
/**
 *
 * @export
 * @interface PermissionData
 */
export interface PermissionData {
    /**
     *
     * @type {string}
     * @memberof PermissionData
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof PermissionData
     */
    value?: string;
    /**
     *
     * @type {string}
     * @memberof PermissionData
     */
    description?: string;
    /**
     *
     * @type {Array<RoleData>}
     * @memberof PermissionData
     */
    roles?: Array<RoleData>;
}
/**
 *
 * @export
 * @interface PermissionDef
 */
export interface PermissionDef {
    /**
     *
     * @type {string}
     * @memberof PermissionDef
     */
    value?: string;
    /**
     *
     * @type {string}
     * @memberof PermissionDef
     */
    description?: string;
}
/**
 *
 * @export
 * @interface Role
 */
export interface Role {
    /**
     *
     * @type {string}
     * @memberof Role
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof Role
     */
    name: string;
    /**
     *
     * @type {string}
     * @memberof Role
     */
    description?: string;
    /**
     *
     * @type {Organisation}
     * @memberof Role
     */
    organisation?: Organisation;
    /**
     *
     * @type {Array<User>}
     * @memberof Role
     */
    users?: Array<User>;
    /**
     *
     * @type {Array<ApiKey>}
     * @memberof Role
     */
    api_keys?: Array<ApiKey>;
    /**
     *
     * @type {Array<Permission>}
     * @memberof Role
     */
    permissions?: Array<Permission>;
    /**
     *
     * @type {boolean}
     * @memberof Role
     */
    system?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Role
     */
    technical?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Role
     */
    group?: boolean;
}
/**
 *
 * @export
 * @interface RoleData
 */
export interface RoleData {
    /**
     *
     * @type {string}
     * @memberof RoleData
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof RoleData
     */
    name?: string;
    /**
     *
     * @type {string}
     * @memberof RoleData
     */
    fullName?: string;
    /**
     *
     * @type {string}
     * @memberof RoleData
     */
    description?: string;
    /**
     *
     * @type {OrgData}
     * @memberof RoleData
     */
    organisation?: OrgData;
    /**
     *
     * @type {boolean}
     * @memberof RoleData
     */
    isGroup?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof RoleData
     */
    isTechnical?: boolean;
}
/**
 *
 * @export
 * @interface RoleDef
 */
export interface RoleDef {
    /**
     *
     * @type {string}
     * @memberof RoleDef
     */
    name?: string;
    /**
     *
     * @type {string}
     * @memberof RoleDef
     */
    description?: string;
}
/**
 *
 * @export
 * @interface UpdateListDef
 */
export interface UpdateListDef {
    /**
     *
     * @type {Array<string>}
     * @memberof UpdateListDef
     */
    ids?: Array<string>;
}
/**
 *
 * @export
 * @interface UpdateUserDef
 */
export interface UpdateUserDef {
    /**
     *
     * @type {string}
     * @memberof UpdateUserDef
     */
    oldPassword?: string;
    /**
     *
     * @type {string}
     * @memberof UpdateUserDef
     */
    newPassword?: string;
    /**
     *
     * @type {string}
     * @memberof UpdateUserDef
     */
    locale?: string;
    /**
     *
     * @type {string}
     * @memberof UpdateUserDef
     */
    timezone?: string;
    /**
     *
     * @type {string}
     * @memberof UpdateUserDef
     */
    firstName?: string;
    /**
     *
     * @type {string}
     * @memberof UpdateUserDef
     */
    lastName?: string;
}
/**
 *
 * @export
 * @interface User
 */
export interface User {
    /**
     *
     * @type {string}
     * @memberof User
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof User
     */
    email?: string;
    /**
     *
     * @type {string}
     * @memberof User
     */
    first_name?: string;
    /**
     *
     * @type {string}
     * @memberof User
     */
    last_name?: string;
    /**
     *
     * @type {string}
     * @memberof User
     */
    locale?: string;
    /**
     *
     * @type {string}
     * @memberof User
     */
    timezone?: string;
    /**
     *
     * @type {Date}
     * @memberof User
     */
    creation_date?: Date;
    /**
     *
     * @type {Date}
     * @memberof User
     */
    update_date?: Date;
    /**
     *
     * @type {Array<OrganisationMember>}
     * @memberof User
     */
    organisations?: Array<OrganisationMember>;
    /**
     *
     * @type {Array<Role>}
     * @memberof User
     */
    roles?: Array<Role>;
    /**
     *
     * @type {Array<ApiKey>}
     * @memberof User
     */
    api_keys?: Array<ApiKey>;
    /**
     *
     * @type {boolean}
     * @memberof User
     */
    active?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof User
     */
    verified?: boolean;
}
/**
 *
 * @export
 * @interface UserData
 */
export interface UserData {
    /**
     *
     * @type {string}
     * @memberof UserData
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof UserData
     */
    email?: string;
    /**
     *
     * @type {string}
     * @memberof UserData
     */
    firstName?: string;
    /**
     *
     * @type {string}
     * @memberof UserData
     */
    lastName?: string;
    /**
     *
     * @type {string}
     * @memberof UserData
     */
    locale?: string;
    /**
     *
     * @type {string}
     * @memberof UserData
     */
    timezone?: string;
    /**
     *
     * @type {number}
     * @memberof UserData
     */
    creationDate?: number;
    /**
     *
     * @type {number}
     * @memberof UserData
     */
    updateDate?: number;
    /**
     *
     * @type {boolean}
     * @memberof UserData
     */
    isVerified?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof UserData
     */
    isActive?: boolean;
    /**
     *
     * @type {Array<UserOrgData>}
     * @memberof UserData
     */
    organisations?: Array<UserOrgData>;
    /**
     *
     * @type {Array<RoleData>}
     * @memberof UserData
     */
    roles?: Array<RoleData>;
}
/**
 *
 * @export
 * @interface UserOrgData
 */
export interface UserOrgData {
    /**
     *
     * @type {string}
     * @memberof UserOrgData
     */
    id?: string;
    /**
     *
     * @type {string}
     * @memberof UserOrgData
     */
    name?: string;
    /**
     *
     * @type {string}
     * @memberof UserOrgData
     */
    displayName?: string;
    /**
     *
     * @type {boolean}
     * @memberof UserOrgData
     */
    isOwner?: boolean;
}
/**
 * DefaultApi - fetch parameter creator
 * @export
 */
export declare const DefaultApiFetchParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Activate the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    activateUser(id: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add column filter permission for the given collections.
     * @param {Array<string>} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addColumnFilterPermission(body: Array<string>, oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add a name to the forbidden organisations list.
     * @param {ForbiddenOrganisation} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addForbiddenOrganisation(body: ForbiddenOrganisation, options?: any): FetchArgs;
    /**
     *
     * @summary Add a group to an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addGroupToOrganisation(body: RoleDef, oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add a permission
     * @param {PermissionDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addPermission(body: PermissionDef, oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add a permission to a role
     * @param {string} oid
     * @param {string} rid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addPermissionToRole(oid: string, rid: string, pid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add a role to an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addRoleToOrganisation(body: RoleDef, oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add a role to a user in an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addRoleToUserInOrganisation(oid: string, uid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Add a user to an organisation. User account will be created if needed.
     * @param {OrgUserDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addUserToOrganisation(body: OrgUserDef, oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Request a password modification if forgotten (send email with link).
     * @param {string} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    askPasswordReset(body: string, options?: any): FetchArgs;
    /**
     *
     * @summary Check if user's organisation exists
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    checkOrganisation(options?: any): FetchArgs;
    /**
     *
     * @summary Create an API Key
     * @param {ApiKeyDef} body
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createApiKey(body: ApiKeyDef, oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Create an organisation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOrganisation(options?: any): FetchArgs;
    /**
     *
     * @summary Create an organisation with a name. Only for IAM admin.
     * @param {string} name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOrganisationWithName(name: string, options?: any): FetchArgs;
    /**
     *
     * @summary Create a user
     * @param {NewUserDef} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createUser(body: NewUserDef, options?: any): FetchArgs;
    /**
     *
     * @summary Deactivate the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deactivateUser(id: string, options?: any): FetchArgs;
    /**
     *
     * @summary Delete an API Key
     * @param {string} oid
     * @param {string} uid
     * @param {string} kid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteApiKey(oid: string, uid: string, kid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Delete a group from an organisation
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteGroupInOrganisation(oid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Delete an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteOrganisation(oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Delete a permission
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePermission(oid: string, pid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Delete the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteUser(id: string, options?: any): FetchArgs;
    /**
     *
     * @summary Validate authentication to another URI
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    forwardAuth(options?: any): FetchArgs;
    /**
     *
     * @summary List collections of a column filter of an organisation
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollectionsOfColumnFiltersInOrganisation(oid: string, pid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List users of same domain than the organisation but not invited yet.
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEmails(oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List groups of a user within an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGroups(oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List groups of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGroupsOfOrganisation(oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List collections of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrganisationCollections(oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List organisations of the logged in user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrganisations(options?: any): FetchArgs;
    /**
     *
     * @summary Get permissions for a user given access token
     * @param {string} [arlas_org_filter]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPermissionToken(arlas_org_filter?: string, options?: any): FetchArgs;
    /**
     *
     * @summary List permissions of a user within an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPermissions(oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List permissions of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPermissionsOfOrganisation(oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List roles of a user within an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRoles(oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List roles of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRolesOfOrganisation(oid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Get a user of an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUser(oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary List users of an organisation
     * @param {string} oid
     * @param {string} [rname]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUsers(oid: string, rname?: string, options?: any): FetchArgs;
    /**
     *
     * @summary Retrieve public keys for JWT validation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    jwks(options?: any): FetchArgs;
    /**
     *
     * @summary List forbidden organisations.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listForbiddenOrganisations(options?: any): FetchArgs;
    /**
     *
     * @summary List permissions of a role
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPermissionOfRole(oid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary User login
     * @param {LoginDef} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    login(body: LoginDef, options?: any): FetchArgs;
    /**
     *
     * @summary Delete session
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    logout(options?: any): FetchArgs;
    /**
     *
     * @summary Modify roles of a user within an organisation
     * @param {UpdateListDef} body
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    putRoles(body: UpdateListDef, oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Read a user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    readUser(id: string, options?: any): FetchArgs;
    /**
     *
     * @summary Refresh access token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    refresh(options?: any): FetchArgs;
    /**
     *
     * @summary Remove a name from the forbidden organisations list.
     * @param {string} name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeNameFromForbiddenOrganisation(name: string, options?: any): FetchArgs;
    /**
     *
     * @summary Remove a permission from a role
     * @param {string} oid
     * @param {string} rid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removePermissionFromRole(oid: string, rid: string, pid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Remove a role from a user from an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeRoleFromUserInOrganisation(oid: string, uid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Remove a user from an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeUserFromOrganisation(oid: string, uid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Reset user password (through link received by email)
     * @param {string} body
     * @param {string} id
     * @param {string} token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resetUserPassword(body: string, id: string, token: string, options?: any): FetchArgs;
    /**
     *
     * @summary Update a column filter permission.
     * @param {Array<string>} body
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateColumnFilterPermission(body: Array<string>, oid: string, pid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Update a role's group in an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateGroupInOrganisation(body: RoleDef, oid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Update a permission
     * @param {PermissionDef} body
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePermission(body: PermissionDef, oid: string, pid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Update permissions of a role
     * @param {UpdateListDef} body
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePermissionOfRole(body: UpdateListDef, oid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Update a role in an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRoleInOrganisation(body: RoleDef, oid: string, rid: string, options?: any): FetchArgs;
    /**
     *
     * @summary Update the given user (absent attribute - null - are not updated).
     * @param {UpdateUserDef} body
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUser(body: UpdateUserDef, id: string, options?: any): FetchArgs;
    /**
     *
     * @summary Verify a user (through link received by email)
     * @param {string} body
     * @param {string} id
     * @param {string} token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    verifyUser(body: string, id: string, token: string, options?: any): FetchArgs;
};
/**
 * DefaultApi - functional programming interface
 * @export
 */
export declare const DefaultApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Activate the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    activateUser(id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Add column filter permission for the given collections.
     * @param {Array<string>} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addColumnFilterPermission(body: Array<string>, oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PermissionData>;
    /**
     *
     * @summary Add a name to the forbidden organisations list.
     * @param {ForbiddenOrganisation} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addForbiddenOrganisation(body: ForbiddenOrganisation, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ForbiddenOrganisation>;
    /**
     *
     * @summary Add a group to an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addGroupToOrganisation(body: RoleDef, oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Add a permission
     * @param {PermissionDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addPermission(body: PermissionDef, oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PermissionData>;
    /**
     *
     * @summary Add a permission to a role
     * @param {string} oid
     * @param {string} rid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addPermissionToRole(oid: string, rid: string, pid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Add a role to an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addRoleToOrganisation(body: RoleDef, oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Add a role to a user in an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addRoleToUserInOrganisation(oid: string, uid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Add a user to an organisation. User account will be created if needed.
     * @param {OrgUserDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addUserToOrganisation(body: OrgUserDef, oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrgData>;
    /**
     *
     * @summary Request a password modification if forgotten (send email with link).
     * @param {string} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    askPasswordReset(body: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Check if user's organisation exists
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    checkOrganisation(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrgExists>;
    /**
     *
     * @summary Create an API Key
     * @param {ApiKeyDef} body
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createApiKey(body: ApiKeyDef, oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ApiKey>;
    /**
     *
     * @summary Create an organisation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOrganisation(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrgData>;
    /**
     *
     * @summary Create an organisation with a name. Only for IAM admin.
     * @param {string} name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOrganisationWithName(name: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrgData>;
    /**
     *
     * @summary Create a user
     * @param {NewUserDef} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createUser(body: NewUserDef, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Deactivate the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deactivateUser(id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Delete an API Key
     * @param {string} oid
     * @param {string} uid
     * @param {string} kid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteApiKey(oid: string, uid: string, kid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Delete a group from an organisation
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteGroupInOrganisation(oid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Delete an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteOrganisation(oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Delete a permission
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePermission(oid: string, pid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Delete the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteUser(id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Validate authentication to another URI
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    forwardAuth(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary List collections of a column filter of an organisation
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollectionsOfColumnFiltersInOrganisation(oid: string, pid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>;
    /**
     *
     * @summary List users of same domain than the organisation but not invited yet.
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEmails(oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>;
    /**
     *
     * @summary List groups of a user within an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGroups(oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<RoleData>>;
    /**
     *
     * @summary List groups of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGroupsOfOrganisation(oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<RoleData>>;
    /**
     *
     * @summary List collections of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrganisationCollections(oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>;
    /**
     *
     * @summary List organisations of the logged in user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrganisations(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<UserOrgData>>;
    /**
     *
     * @summary Get permissions for a user given access token
     * @param {string} [arlas_org_filter]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPermissionToken(arlas_org_filter?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<string>;
    /**
     *
     * @summary List permissions of a user within an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPermissions(oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<PermissionData>>;
    /**
     *
     * @summary List permissions of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPermissionsOfOrganisation(oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<PermissionData>>;
    /**
     *
     * @summary List roles of a user within an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRoles(oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<RoleData>>;
    /**
     *
     * @summary List roles of an organisation
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRolesOfOrganisation(oid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<RoleData>>;
    /**
     *
     * @summary Get a user of an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUser(oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<MemberData>;
    /**
     *
     * @summary List users of an organisation
     * @param {string} oid
     * @param {string} [rname]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUsers(oid: string, rname?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<MemberData>>;
    /**
     *
     * @summary Retrieve public keys for JWT validation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    jwks(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary List forbidden organisations.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listForbiddenOrganisations(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<ForbiddenOrganisation>>;
    /**
     *
     * @summary List permissions of a role
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPermissionOfRole(oid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<PermissionData>>;
    /**
     *
     * @summary User login
     * @param {LoginDef} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    login(body: LoginDef, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<LoginData>;
    /**
     *
     * @summary Delete session
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    logout(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Modify roles of a user within an organisation
     * @param {UpdateListDef} body
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    putRoles(body: UpdateListDef, oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Read a user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    readUser(id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Refresh access token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    refresh(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<LoginData>;
    /**
     *
     * @summary Remove a name from the forbidden organisations list.
     * @param {string} name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeNameFromForbiddenOrganisation(name: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ArlasMessage>;
    /**
     *
     * @summary Remove a permission from a role
     * @param {string} oid
     * @param {string} rid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removePermissionFromRole(oid: string, rid: string, pid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Remove a role from a user from an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeRoleFromUserInOrganisation(oid: string, uid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Remove a user from an organisation
     * @param {string} oid
     * @param {string} uid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeUserFromOrganisation(oid: string, uid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrgData>;
    /**
     *
     * @summary Reset user password (through link received by email)
     * @param {string} body
     * @param {string} id
     * @param {string} token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resetUserPassword(body: string, id: string, token: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Update a column filter permission.
     * @param {Array<string>} body
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateColumnFilterPermission(body: Array<string>, oid: string, pid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PermissionData>;
    /**
     *
     * @summary Update a role's group in an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateGroupInOrganisation(body: RoleDef, oid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Update a permission
     * @param {PermissionDef} body
     * @param {string} oid
     * @param {string} pid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePermission(body: PermissionDef, oid: string, pid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PermissionData>;
    /**
     *
     * @summary Update permissions of a role
     * @param {UpdateListDef} body
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePermissionOfRole(body: UpdateListDef, oid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Update a role in an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {string} rid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRoleInOrganisation(body: RoleDef, oid: string, rid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RoleData>;
    /**
     *
     * @summary Update the given user (absent attribute - null - are not updated).
     * @param {UpdateUserDef} body
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUser(body: UpdateUserDef, id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
    /**
     *
     * @summary Verify a user (through link received by email)
     * @param {string} body
     * @param {string} id
     * @param {string} token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    verifyUser(body: string, id: string, token: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserData>;
};
/**
 * DefaultApi - factory interface
 * @export
 */
export declare const DefaultApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
    /**
     *
     * @summary Activate the given user
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    activateUser(id: string, options?: any): Promise<ArlasMessage>;
    /**
     *
     * @summary Add column filter permission for the given collections.
     * @param {Array<string>} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addColumnFilterPermission(body: Array<string>, oid: string, options?: any): Promise<PermissionData>;
    /**
     *
     * @summary Add a name to the forbidden organisations list.
     * @param {ForbiddenOrganisation} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addForbiddenOrganisation(body: ForbiddenOrganisation, options?: any): Promise<ForbiddenOrganisation>;
    /**
     *
     * @summary Add a group to an organisation
     * @param {RoleDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addGroupToOrganisation(body: RoleDef, oid: string, options?: any): Promise<RoleData>;
    /**
     *
     * @summary Add a permission
     * @param {PermissionDef} body
     * @param {string} oid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addPermission(body: PermissionDef, oid: string, options?: any): Promise<PermissionData>;
    /**
     *
     * @summary Add a permission to a role
     * @param {str