/** * Permit.io API * Authorization as a service * * The version of the OpenAPI document: 2.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { ElementsRoleRead } from '../types'; import { ElementsUserCreate } from '../types'; import { ElementsUserRoleCreate } from '../types'; import { ElementsUserRoleRemove } from '../types'; import { PaginatedResultUserRead } from '../types'; import { RoleAssignmentRead } from '../types'; import { UserRead } from '../types'; /** * UsersElementsDataApi - axios parameter creator * @export */ export declare const UsersElementsDataApiAxiosParamCreator: (configuration?: Configuration) => { /** * Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. * @summary Assign role to user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {ElementsUserRoleCreate} elementsUserRoleCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsAssignRoleToUser: (projId: string, envId: string, elementsConfigId: string, userId: string, elementsUserRoleCreate: ElementsUserRoleCreate, options?: AxiosRequestConfig) => Promise; /** * Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body. * @summary Create user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {ElementsUserCreate} elementsUserCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsCreateUser: (projId: string, envId: string, elementsConfigId: string, elementsUserCreate: ElementsUserCreate, options?: AxiosRequestConfig) => Promise; /** * * @summary Delete user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsDeleteUser: (projId: string, envId: string, elementsConfigId: string, userId: string, options?: AxiosRequestConfig) => Promise; /** * Lists all the users defined within an environment. * @summary List roles * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} [search] Text search for the email field * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsListRoles: (projId: string, envId: string, elementsConfigId: string, search?: string, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise; /** * Lists all the users defined within an environment. * @summary List users * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} [search] Text search for the email field * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsListUsers: (projId: string, envId: string, elementsConfigId: string, search?: string, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise; /** * Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404. * @summary Unassign role from user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {ElementsUserRoleRemove} elementsUserRoleRemove * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsUnassignRoleFromUser: (projId: string, envId: string, elementsConfigId: string, userId: string, elementsUserRoleRemove: ElementsUserRoleRemove, options?: AxiosRequestConfig) => Promise; /** * Updates the embed_config. * @summary Set Config Active * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {*} [options] Override http request option. * @throws {RequiredError} */ setConfigActive: (elementsConfigId: string, projId: string, envId: string, options?: AxiosRequestConfig) => Promise; }; /** * UsersElementsDataApi - functional programming interface * @export */ export declare const UsersElementsDataApiFp: (configuration?: Configuration) => { /** * Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. * @summary Assign role to user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {ElementsUserRoleCreate} elementsUserRoleCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsAssignRoleToUser(projId: string, envId: string, elementsConfigId: string, userId: string, elementsUserRoleCreate: ElementsUserRoleCreate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body. * @summary Create user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {ElementsUserCreate} elementsUserCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsCreateUser(projId: string, envId: string, elementsConfigId: string, elementsUserCreate: ElementsUserCreate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsDeleteUser(projId: string, envId: string, elementsConfigId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all the users defined within an environment. * @summary List roles * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} [search] Text search for the email field * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsListRoles(projId: string, envId: string, elementsConfigId: string, search?: string, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Lists all the users defined within an environment. * @summary List users * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} [search] Text search for the email field * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsListUsers(projId: string, envId: string, elementsConfigId: string, search?: string, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404. * @summary Unassign role from user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {ElementsUserRoleRemove} elementsUserRoleRemove * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsUnassignRoleFromUser(projId: string, envId: string, elementsConfigId: string, userId: string, elementsUserRoleRemove: ElementsUserRoleRemove, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the embed_config. * @summary Set Config Active * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {*} [options] Override http request option. * @throws {RequiredError} */ setConfigActive(elementsConfigId: string, projId: string, envId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersElementsDataApi - factory interface * @export */ export declare const UsersElementsDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. * @summary Assign role to user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {ElementsUserRoleCreate} elementsUserRoleCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsAssignRoleToUser(projId: string, envId: string, elementsConfigId: string, userId: string, elementsUserRoleCreate: ElementsUserRoleCreate, options?: any): AxiosPromise; /** * Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body. * @summary Create user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {ElementsUserCreate} elementsUserCreate * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsCreateUser(projId: string, envId: string, elementsConfigId: string, elementsUserCreate: ElementsUserCreate, options?: any): AxiosPromise; /** * * @summary Delete user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsDeleteUser(projId: string, envId: string, elementsConfigId: string, userId: string, options?: any): AxiosPromise; /** * Lists all the users defined within an environment. * @summary List roles * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} [search] Text search for the email field * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsListRoles(projId: string, envId: string, elementsConfigId: string, search?: string, page?: number, perPage?: number, options?: any): AxiosPromise>; /** * Lists all the users defined within an environment. * @summary List users * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} [search] Text search for the email field * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsListUsers(projId: string, envId: string, elementsConfigId: string, search?: string, page?: number, perPage?: number, options?: any): AxiosPromise; /** * Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404. * @summary Unassign role from user * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @param {ElementsUserRoleRemove} elementsUserRoleRemove * @param {*} [options] Override http request option. * @throws {RequiredError} */ elementsUnassignRoleFromUser(projId: string, envId: string, elementsConfigId: string, userId: string, elementsUserRoleRemove: ElementsUserRoleRemove, options?: any): AxiosPromise; /** * Updates the embed_config. * @summary Set Config Active * @param {string} elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {*} [options] Override http request option. * @throws {RequiredError} */ setConfigActive(elementsConfigId: string, projId: string, envId: string, options?: any): AxiosPromise; }; /** * Request parameters for elementsAssignRoleToUser operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiElementsAssignRoleToUserRequest */ export interface UsersElementsDataApiElementsAssignRoleToUserRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsAssignRoleToUser */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsAssignRoleToUser */ readonly envId: string; /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsAssignRoleToUser */ readonly elementsConfigId: string; /** * Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsAssignRoleToUser */ readonly userId: string; /** * * @type {ElementsUserRoleCreate} * @memberof UsersElementsDataApiElementsAssignRoleToUser */ readonly elementsUserRoleCreate: ElementsUserRoleCreate; } /** * Request parameters for elementsCreateUser operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiElementsCreateUserRequest */ export interface UsersElementsDataApiElementsCreateUserRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsCreateUser */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsCreateUser */ readonly envId: string; /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsCreateUser */ readonly elementsConfigId: string; /** * * @type {ElementsUserCreate} * @memberof UsersElementsDataApiElementsCreateUser */ readonly elementsUserCreate: ElementsUserCreate; } /** * Request parameters for elementsDeleteUser operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiElementsDeleteUserRequest */ export interface UsersElementsDataApiElementsDeleteUserRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsDeleteUser */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsDeleteUser */ readonly envId: string; /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsDeleteUser */ readonly elementsConfigId: string; /** * Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsDeleteUser */ readonly userId: string; } /** * Request parameters for elementsListRoles operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiElementsListRolesRequest */ export interface UsersElementsDataApiElementsListRolesRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsListRoles */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsListRoles */ readonly envId: string; /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsListRoles */ readonly elementsConfigId: string; /** * Text search for the email field * @type {string} * @memberof UsersElementsDataApiElementsListRoles */ readonly search?: string; /** * Page number of the results to fetch, starting at 1. * @type {number} * @memberof UsersElementsDataApiElementsListRoles */ readonly page?: number; /** * The number of results per page (max 100). * @type {number} * @memberof UsersElementsDataApiElementsListRoles */ readonly perPage?: number; } /** * Request parameters for elementsListUsers operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiElementsListUsersRequest */ export interface UsersElementsDataApiElementsListUsersRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsListUsers */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsListUsers */ readonly envId: string; /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsListUsers */ readonly elementsConfigId: string; /** * Text search for the email field * @type {string} * @memberof UsersElementsDataApiElementsListUsers */ readonly search?: string; /** * Page number of the results to fetch, starting at 1. * @type {number} * @memberof UsersElementsDataApiElementsListUsers */ readonly page?: number; /** * The number of results per page (max 100). * @type {number} * @memberof UsersElementsDataApiElementsListUsers */ readonly perPage?: number; } /** * Request parameters for elementsUnassignRoleFromUser operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiElementsUnassignRoleFromUserRequest */ export interface UsersElementsDataApiElementsUnassignRoleFromUserRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsUnassignRoleFromUser */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsUnassignRoleFromUser */ readonly envId: string; /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsUnassignRoleFromUser */ readonly elementsConfigId: string; /** * Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiElementsUnassignRoleFromUser */ readonly userId: string; /** * * @type {ElementsUserRoleRemove} * @memberof UsersElementsDataApiElementsUnassignRoleFromUser */ readonly elementsUserRoleRemove: ElementsUserRoleRemove; } /** * Request parameters for setConfigActive operation in UsersElementsDataApi. * @export * @interface UsersElementsDataApiSetConfigActiveRequest */ export interface UsersElementsDataApiSetConfigActiveRequest { /** * Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiSetConfigActive */ readonly elementsConfigId: string; /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiSetConfigActive */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof UsersElementsDataApiSetConfigActive */ readonly envId: string; } /** * UsersElementsDataApi - object-oriented interface * @export * @class UsersElementsDataApi * @extends {BaseAPI} */ export declare class UsersElementsDataApi extends BaseAPI { /** * Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. * @summary Assign role to user * @param {UsersElementsDataApiElementsAssignRoleToUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ elementsAssignRoleToUser(requestParameters: UsersElementsDataApiElementsAssignRoleToUserRequest, options?: AxiosRequestConfig): Promise>; /** * Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body. * @summary Create user * @param {UsersElementsDataApiElementsCreateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ elementsCreateUser(requestParameters: UsersElementsDataApiElementsCreateUserRequest, options?: AxiosRequestConfig): Promise>; /** * * @summary Delete user * @param {UsersElementsDataApiElementsDeleteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ elementsDeleteUser(requestParameters: UsersElementsDataApiElementsDeleteUserRequest, options?: AxiosRequestConfig): Promise>; /** * Lists all the users defined within an environment. * @summary List roles * @param {UsersElementsDataApiElementsListRolesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ elementsListRoles(requestParameters: UsersElementsDataApiElementsListRolesRequest, options?: AxiosRequestConfig): Promise>; /** * Lists all the users defined within an environment. * @summary List users * @param {UsersElementsDataApiElementsListUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ elementsListUsers(requestParameters: UsersElementsDataApiElementsListUsersRequest, options?: AxiosRequestConfig): Promise>; /** * Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404. * @summary Unassign role from user * @param {UsersElementsDataApiElementsUnassignRoleFromUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ elementsUnassignRoleFromUser(requestParameters: UsersElementsDataApiElementsUnassignRoleFromUserRequest, options?: AxiosRequestConfig): Promise>; /** * Updates the embed_config. * @summary Set Config Active * @param {UsersElementsDataApiSetConfigActiveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersElementsDataApi */ setConfigActive(requestParameters: UsersElementsDataApiSetConfigActiveRequest, options?: AxiosRequestConfig): Promise>; }