UNPKG

@dustlight/auth-client-axios-js

Version:

Javascript Client SDK for Auth-Service

1,843 lines 197 kB
/** * Auth Service * 提供身份管理服务以及OAuth2授权服务。身份管理服务包含用户管理、角色管理、权限管理等,OAuth2授权服务包含应用管理、应用授权模式与授权作用域管理等。 * * The version of the OpenAPI document: v1 * Contact: hansin@dustlight.cn * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface Authority */ export interface Authority { /** * * @type {number} * @memberof Authority */ aid?: number; /** * * @type {string} * @memberof Authority */ authorityName?: string; /** * * @type {string} * @memberof Authority */ authorityDescription?: string; /** * * @type {string} * @memberof Authority */ createdAt?: string; /** * * @type {string} * @memberof Authority */ updatedAt?: string; } /** * * @export * @interface AuthorizationClient */ export interface AuthorizationClient { /** * * @type {string} * @memberof AuthorizationClient */ name?: string; /** * * @type {string} * @memberof AuthorizationClient */ description?: string; /** * * @type {string} * @memberof AuthorizationClient */ logo?: string; /** * * @type {{ [key: string]: object; }} * @memberof AuthorizationClient */ additionalInformation?: { [key: string]: object; }; /** * * @type {string} * @memberof AuthorizationClient */ createdAt?: string; /** * * @type {string} * @memberof AuthorizationClient */ updatedAt?: string; /** * * @type {number} * @memberof AuthorizationClient */ status?: number; /** * * @type {number} * @memberof AuthorizationClient */ uid?: number; /** * * @type {Array<Resource>} * @memberof AuthorizationClient */ resources?: Array<Resource>; /** * * @type {Array<string>} * @memberof AuthorizationClient */ members?: Array<string>; /** * * @type {Array<AuthorizationClientScope>} * @memberof AuthorizationClient */ scopes?: Array<AuthorizationClientScope>; /** * * @type {Array<GrantType>} * @memberof AuthorizationClient */ types?: Array<GrantType>; /** * * @type {Array<string>} * @memberof AuthorizationClient */ authorities?: Array<string>; /** * * @type {string} * @memberof AuthorizationClient */ clientSecret?: string; /** * * @type {Set<string>} * @memberof AuthorizationClient */ registeredRedirectUri?: Set<string>; /** * * @type {number} * @memberof AuthorizationClient */ refreshTokenValiditySeconds?: number; /** * * @type {number} * @memberof AuthorizationClient */ accessTokenValiditySeconds?: number; /** * * @type {string} * @memberof AuthorizationClient */ cid?: string; } /** * * @export * @interface AuthorizationClientScope */ export interface AuthorizationClientScope { /** * * @type {number} * @memberof AuthorizationClientScope */ sid?: number; /** * * @type {string} * @memberof AuthorizationClientScope */ name?: string; /** * * @type {string} * @memberof AuthorizationClientScope */ subtitle?: string; /** * * @type {string} * @memberof AuthorizationClientScope */ description?: string; /** * * @type {boolean} * @memberof AuthorizationClientScope */ approved?: boolean; } /** * * @export * @interface AuthorizationResponse */ export interface AuthorizationResponse { /** * * @type {AuthorizationClient} * @memberof AuthorizationResponse */ client?: AuthorizationClient; /** * * @type {PublicUser} * @memberof AuthorizationResponse */ owner?: PublicUser; /** * * @type {string} * @memberof AuthorizationResponse */ redirect?: string; /** * * @type {number} * @memberof AuthorizationResponse */ count?: number; /** * * @type {boolean} * @memberof AuthorizationResponse */ approved?: boolean; } /** * * @export * @interface Client */ export interface Client { /** * * @type {string} * @memberof Client */ name?: string; /** * * @type {Array<string>} * @memberof Client */ members?: Array<string>; /** * * @type {string} * @memberof Client */ description?: string; /** * * @type {Array<string>} * @memberof Client */ authorities?: Array<string>; /** * * @type {number} * @memberof Client */ status?: number; /** * * @type {number} * @memberof Client */ uid?: number; /** * * @type {Array<ClientScope>} * @memberof Client */ scopes?: Array<ClientScope>; /** * * @type {string} * @memberof Client */ logo?: string; /** * * @type {string} * @memberof Client */ createdAt?: string; /** * * @type {string} * @memberof Client */ updatedAt?: string; /** * * @type {Set<string>} * @memberof Client */ resources?: Set<string>; /** * * @type {string} * @memberof Client */ cid?: string; /** * * @type {{ [key: string]: object; }} * @memberof Client */ extra?: { [key: string]: object; }; /** * * @type {string} * @memberof Client */ secret?: string; /** * * @type {Set<string>} * @memberof Client */ redirectUri?: Set<string>; /** * * @type {Set<string>} * @memberof Client */ grantTypes?: Set<string>; /** * * @type {number} * @memberof Client */ refreshTokenValidity?: number; /** * * @type {number} * @memberof Client */ accessTokenValidity?: number; } /** * * @export * @interface ClientScope */ export interface ClientScope { /** * * @type {boolean} * @memberof ClientScope */ autoApprove?: boolean; /** * * @type {string} * @memberof ClientScope */ name?: string; /** * * @type {string} * @memberof ClientScope */ description?: string; /** * * @type {number} * @memberof ClientScope */ sid?: number; /** * * @type {string} * @memberof ClientScope */ subtitle?: string; } /** * * @export * @interface GrantType */ export interface GrantType { /** * * @type {number} * @memberof GrantType */ tid?: number; /** * * @type {string} * @memberof GrantType */ name?: string; /** * * @type {string} * @memberof GrantType */ description?: string; /** * * @type {string} * @memberof GrantType */ createdAt?: string; /** * * @type {string} * @memberof GrantType */ updatedAt?: string; } /** * * @export * @interface OAuth2AccessToken */ export interface OAuth2AccessToken { /** * * @type {string} * @memberof OAuth2AccessToken */ value?: string; /** * * @type {string} * @memberof OAuth2AccessToken */ expiration?: string; /** * * @type {Set<string>} * @memberof OAuth2AccessToken */ scope?: Set<string>; /** * * @type {string} * @memberof OAuth2AccessToken */ tokenType?: string; /** * * @type {boolean} * @memberof OAuth2AccessToken */ expired?: boolean; /** * * @type {{ [key: string]: object; }} * @memberof OAuth2AccessToken */ additionalInformation?: { [key: string]: object; }; /** * * @type {OAuth2RefreshToken} * @memberof OAuth2AccessToken */ refreshToken?: OAuth2RefreshToken; /** * * @type {number} * @memberof OAuth2AccessToken */ expiresIn?: number; } /** * * @export * @interface OAuth2RefreshToken */ export interface OAuth2RefreshToken { /** * * @type {string} * @memberof OAuth2RefreshToken */ value?: string; } /** * * @export * @interface PublicUser */ export interface PublicUser { /** * * @type {number} * @memberof PublicUser */ uid?: number; /** * * @type {string} * @memberof PublicUser */ avatar?: string; /** * * @type {string} * @memberof PublicUser */ unlockedAt?: string; /** * * @type {string} * @memberof PublicUser */ nickname?: string; /** * * @type {number} * @memberof PublicUser */ gender?: number; /** * * @type {boolean} * @memberof PublicUser */ enabled?: boolean; /** * * @type {string} * @memberof PublicUser */ username?: string; /** * * @type {boolean} * @memberof PublicUser */ accountNonLocked?: boolean; /** * * @type {boolean} * @memberof PublicUser */ accountNonExpired?: boolean; /** * * @type {boolean} * @memberof PublicUser */ credentialsNonExpired?: boolean; /** * * @type {string} * @memberof PublicUser */ createdAt?: string; } /** * * @export * @interface QueryResultsClient */ export interface QueryResultsClient { /** * * @type {number} * @memberof QueryResultsClient */ count?: number; /** * * @type {Array<Client>} * @memberof QueryResultsClient */ data?: Array<Client>; } /** * * @export * @interface QueryResultsUser */ export interface QueryResultsUser { /** * * @type {number} * @memberof QueryResultsUser */ count?: number; /** * * @type {Array<User>} * @memberof QueryResultsUser */ data?: Array<User>; } /** * * @export * @interface Resource */ export interface Resource { /** * * @type {string} * @memberof Resource */ name?: string; /** * * @type {string} * @memberof Resource */ rid?: string; /** * * @type {string} * @memberof Resource */ createdAt?: string; /** * * @type {string} * @memberof Resource */ updatedAt?: string; } /** * * @export * @interface Role */ export interface Role { /** * * @type {number} * @memberof Role */ rid?: number; /** * * @type {string} * @memberof Role */ roleName?: string; /** * * @type {string} * @memberof Role */ roleDescription?: string; /** * * @type {string} * @memberof Role */ createdAt?: string; /** * * @type {string} * @memberof Role */ updatedAt?: string; } /** * * @export * @interface Scope */ export interface Scope { /** * * @type {number} * @memberof Scope */ sid?: number; /** * * @type {string} * @memberof Scope */ name?: string; /** * * @type {string} * @memberof Scope */ subtitle?: string; /** * * @type {string} * @memberof Scope */ description?: string; /** * * @type {string} * @memberof Scope */ createdAt?: string; /** * * @type {string} * @memberof Scope */ updatedAt?: string; } /** * * @export * @interface User */ export interface User { /** * * @type {Array<string>} * @memberof User */ authorities?: Array<string>; /** * * @type {number} * @memberof User */ uid?: number; /** * * @type {string} * @memberof User */ email?: string; /** * * @type {string} * @memberof User */ phone?: string; /** * * @type {string} * @memberof User */ avatar?: string; /** * * @type {string} * @memberof User */ unlockedAt?: string; /** * * @type {string} * @memberof User */ nickname?: string; /** * * @type {number} * @memberof User */ gender?: number; /** * * @type {string} * @memberof User */ accountExpiredAt?: string; /** * * @type {string} * @memberof User */ credentialsExpiredAt?: string; /** * * @type {boolean} * @memberof User */ enabled?: boolean; /** * * @type {string} * @memberof User */ username?: string; /** * * @type {boolean} * @memberof User */ accountNonLocked?: boolean; /** * * @type {boolean} * @memberof User */ accountNonExpired?: boolean; /** * * @type {boolean} * @memberof User */ credentialsNonExpired?: boolean; /** * * @type {string} * @memberof User */ createdAt?: string; /** * * @type {string} * @memberof User */ updatedAt?: string; /** * * @type {Array<UserRole>} * @memberof User */ roles?: Array<UserRole>; } /** * * @export * @interface UserRole */ export interface UserRole { /** * * @type {number} * @memberof UserRole */ rid?: number; /** * * @type {string} * @memberof UserRole */ roleName?: string; /** * * @type {string} * @memberof UserRole */ roleDescription?: string; /** * * @type {string} * @memberof UserRole */ expiredAt?: string; /** * * @type {boolean} * @memberof UserRole */ expired?: boolean; } /** * * @export * @interface UserRoleClient */ export interface UserRoleClient { /** * * @type {string} * @memberof UserRoleClient */ name?: string; /** * * @type {string} * @memberof UserRoleClient */ description?: string; /** * * @type {string} * @memberof UserRoleClient */ logo?: string; /** * * @type {string} * @memberof UserRoleClient */ createdAt?: string; /** * * @type {string} * @memberof UserRoleClient */ updatedAt?: string; /** * * @type {number} * @memberof UserRoleClient */ status?: number; /** * * @type {number} * @memberof UserRoleClient */ uid?: number; /** * * @type {Set<string>} * @memberof UserRoleClient */ resources?: Set<string>; /** * * @type {Array<string>} * @memberof UserRoleClient */ members?: Array<string>; /** * * @type {Array<ClientScope>} * @memberof UserRoleClient */ scopes?: Array<ClientScope>; /** * * @type {Array<GrantType>} * @memberof UserRoleClient */ types?: Array<GrantType>; /** * * @type {Array<string>} * @memberof UserRoleClient */ authorities?: Array<string>; /** * * @type {number} * @memberof UserRoleClient */ count?: number; /** * * @type {string} * @memberof UserRoleClient */ clientSecret?: string; /** * * @type {{ [key: string]: object; }} * @memberof UserRoleClient */ extra?: { [key: string]: object; }; /** * * @type {string} * @memberof UserRoleClient */ cid?: string; /** * * @type {Set<string>} * @memberof UserRoleClient */ redirectUri?: Set<string>; /** * * @type {Set<string>} * @memberof UserRoleClient */ grantTypes?: Set<string>; /** * * @type {number} * @memberof UserRoleClient */ refreshTokenValidity?: number; /** * * @type {number} * @memberof UserRoleClient */ accessTokenValidity?: number; } /** * AuthoritiesApi - axios parameter creator * @export */ export declare const AuthoritiesApiAxiosParamCreator: (configuration?: Configuration) => { /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 删除权限 * @param {Array<number>} requestBody * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAuthorities: (requestBody: Array<number>, clientId?: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 删除应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientAuthorities: (cid: string, authorityId: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 删除角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRoleAuthorities: (rid: number, authorityId: Array<number>, clientId?: string, options?: any) => Promise<RequestArgs>; /** * * @summary 获取权限 * @param {Array<number>} [id] * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorities: (id?: Array<number>, clientId?: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClientAuthorities: (cid: string, options?: any) => Promise<RequestArgs>; /** * * @summary 获取角色权限 * @param {number} rid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoleAuthorities: (rid: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserClientAuthorities: (uid: number, cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 修改或添加权限 * @param {Array<Authority>} authority * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAuthorities: (authority: Array<Authority>, clientId?: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 添加应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setClientAuthorities: (cid: string, authorityId: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 添加角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setRoleAuthorities: (rid: number, authorityId: Array<number>, clientId?: string, options?: any) => Promise<RequestArgs>; }; /** * AuthoritiesApi - functional programming interface * @export */ export declare const AuthoritiesApiFp: (configuration?: Configuration) => { /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 删除权限 * @param {Array<number>} requestBody * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAuthorities(requestBody: Array<number>, clientId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 删除应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientAuthorities(cid: string, authorityId: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 删除角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRoleAuthorities(rid: number, authorityId: Array<number>, clientId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary 获取权限 * @param {Array<number>} [id] * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorities(id?: Array<number>, clientId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Authority>>>; /** * 应用和用户需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClientAuthorities(cid: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>; /** * * @summary 获取角色权限 * @param {number} rid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoleAuthorities(rid: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserClientAuthorities(uid: number, cid: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>; /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 修改或添加权限 * @param {Array<Authority>} authority * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAuthorities(authority: Array<Authority>, clientId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Authority>>>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 添加应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setClientAuthorities(cid: string, authorityId: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 添加角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setRoleAuthorities(rid: number, authorityId: Array<number>, clientId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; }; /** * AuthoritiesApi - factory interface * @export */ export declare const AuthoritiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 删除权限 * @param {Array<number>} requestBody * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAuthorities(requestBody: Array<number>, clientId?: string, options?: any): AxiosPromise<void>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 删除应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientAuthorities(cid: string, authorityId: Array<number>, options?: any): AxiosPromise<void>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 删除角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRoleAuthorities(rid: number, authorityId: Array<number>, clientId?: string, options?: any): AxiosPromise<void>; /** * * @summary 获取权限 * @param {Array<number>} [id] * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorities(id?: Array<number>, clientId?: string, options?: any): AxiosPromise<Array<Authority>>; /** * 应用和用户需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClientAuthorities(cid: string, options?: any): AxiosPromise<Array<string>>; /** * * @summary 获取角色权限 * @param {number} rid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoleAuthorities(rid: number, options?: any): AxiosPromise<Array<string>>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserClientAuthorities(uid: number, cid: string, options?: any): AxiosPromise<Array<string>>; /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 修改或添加权限 * @param {Array<Authority>} authority * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAuthorities(authority: Array<Authority>, clientId?: string, options?: any): AxiosPromise<Array<Authority>>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 添加应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setClientAuthorities(cid: string, authorityId: Array<number>, options?: any): AxiosPromise<void>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 添加角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setRoleAuthorities(rid: number, authorityId: Array<number>, clientId?: string, options?: any): AxiosPromise<void>; }; /** * AuthoritiesApi - object-oriented interface * @export * @class AuthoritiesApi * @extends {BaseAPI} */ export declare class AuthoritiesApi extends BaseAPI { /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 删除权限 * @param {Array<number>} requestBody * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ deleteAuthorities(requestBody: Array<number>, clientId?: string, options?: any): Promise<import("axios").AxiosResponse<void>>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 删除应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ deleteClientAuthorities(cid: string, authorityId: Array<number>, options?: any): Promise<import("axios").AxiosResponse<void>>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 删除角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ deleteRoleAuthorities(rid: number, authorityId: Array<number>, clientId?: string, options?: any): Promise<import("axios").AxiosResponse<void>>; /** * * @summary 获取权限 * @param {Array<number>} [id] * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ getAuthorities(id?: Array<number>, clientId?: string, options?: any): Promise<import("axios").AxiosResponse<Authority[]>>; /** * 应用和用户需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ getClientAuthorities(cid: string, options?: any): Promise<import("axios").AxiosResponse<string[]>>; /** * * @summary 获取角色权限 * @param {number} rid * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ getRoleAuthorities(rid: number, options?: any): Promise<import("axios").AxiosResponse<string[]>>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 获取应用权限 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ getUserClientAuthorities(uid: number, cid: string, options?: any): Promise<import("axios").AxiosResponse<string[]>>; /** * 应用和用户需要 WRITE_AUTHORITY 权限。 * @summary 修改或添加权限 * @param {Array<Authority>} authority * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ setAuthorities(authority: Array<Authority>, clientId?: string, options?: any): Promise<import("axios").AxiosResponse<Authority[]>>; /** * 应用和用户需要 GRANT_CLIENT 权限。 * @summary 添加应用权限 * @param {string} cid * @param {Array<number>} authorityId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ setClientAuthorities(cid: string, authorityId: Array<number>, options?: any): Promise<import("axios").AxiosResponse<void>>; /** * 应用和用户需要 GRANT_ROLE 权限。 * @summary 添加角色权限 * @param {number} rid * @param {Array<number>} authorityId * @param {string} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthoritiesApi */ setRoleAuthorities(rid: number, authorityId: Array<number>, clientId?: string, options?: any): Promise<import("axios").AxiosResponse<void>>; } /** * AuthorizationApi - axios parameter creator * @export */ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => { /** * 应用需要 AUTHORIZE 权限。 * @summary 应用授权 * @param {boolean} approved * @param {Set<string>} [scope] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAuthorization: (approved: boolean, scope?: Set<string>, jwt?: boolean, options?: any) => Promise<RequestArgs>; /** * 获取包含应用信息、所属用户信息、回调地址以及是否已授权。应用需要 AUTHORIZE 权限。 * @summary 获取应用授权 * @param {string} clientId * @param {string} [responseType] * @param {string} [redirectUri] * @param {Array<string>} [scope] * @param {string} [state] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorization: (clientId: string, responseType?: string, redirectUri?: string, scope?: Array<string>, state?: string, jwt?: boolean, options?: any) => Promise<RequestArgs>; }; /** * AuthorizationApi - functional programming interface * @export */ export declare const AuthorizationApiFp: (configuration?: Configuration) => { /** * 应用需要 AUTHORIZE 权限。 * @summary 应用授权 * @param {boolean} approved * @param {Set<string>} [scope] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAuthorization(approved: boolean, scope?: Set<string>, jwt?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>; /** * 获取包含应用信息、所属用户信息、回调地址以及是否已授权。应用需要 AUTHORIZE 权限。 * @summary 获取应用授权 * @param {string} clientId * @param {string} [responseType] * @param {string} [redirectUri] * @param {Array<string>} [scope] * @param {string} [state] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorization(clientId: string, responseType?: string, redirectUri?: string, scope?: Array<string>, state?: string, jwt?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>; }; /** * AuthorizationApi - factory interface * @export */ export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 应用需要 AUTHORIZE 权限。 * @summary 应用授权 * @param {boolean} approved * @param {Set<string>} [scope] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAuthorization(approved: boolean, scope?: Set<string>, jwt?: boolean, options?: any): AxiosPromise<AuthorizationResponse>; /** * 获取包含应用信息、所属用户信息、回调地址以及是否已授权。应用需要 AUTHORIZE 权限。 * @summary 获取应用授权 * @param {string} clientId * @param {string} [responseType] * @param {string} [redirectUri] * @param {Array<string>} [scope] * @param {string} [state] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorization(clientId: string, responseType?: string, redirectUri?: string, scope?: Array<string>, state?: string, jwt?: boolean, options?: any): AxiosPromise<AuthorizationResponse>; }; /** * AuthorizationApi - object-oriented interface * @export * @class AuthorizationApi * @extends {BaseAPI} */ export declare class AuthorizationApi extends BaseAPI { /** * 应用需要 AUTHORIZE 权限。 * @summary 应用授权 * @param {boolean} approved * @param {Set<string>} [scope] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ createAuthorization(approved: boolean, scope?: Set<string>, jwt?: boolean, options?: any): Promise<import("axios").AxiosResponse<AuthorizationResponse>>; /** * 获取包含应用信息、所属用户信息、回调地址以及是否已授权。应用需要 AUTHORIZE 权限。 * @summary 获取应用授权 * @param {string} clientId * @param {string} [responseType] * @param {string} [redirectUri] * @param {Array<string>} [scope] * @param {string} [state] * @param {boolean} [jwt] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ getAuthorization(clientId: string, responseType?: string, redirectUri?: string, scope?: Array<string>, state?: string, jwt?: boolean, options?: any): Promise<import("axios").AxiosResponse<AuthorizationResponse>>; } /** * ClientsApi - axios parameter creator * @export */ export declare const ClientsApiAxiosParamCreator: (configuration?: Configuration) => { /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 添加应用成员 * @param {string} cid * @param {Array<number>} uids * @param {*} [options] Override http request option. * @throws {RequiredError} */ addClientMembers: (cid: string, uids: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 添加应用成员 * @param {number} uid * @param {string} cid * @param {Array<number>} uids * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserClientMembers: (uid: number, cid: string, uids: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 创建应用 * @param {number} uid * @param {string} name * @param {string} description * @param {string} redirectUri * @param {Array<number>} [scopes] * @param {Array<number>} [grantTypes] * @param {number} [accessTokenValidity] * @param {number} [refreshTokenValidity] * @param {string} [additionalInformation] * @param {number} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClient: (uid: number, name: string, description: string, redirectUri: string, scopes?: Array<number>, grantTypes?: Array<number>, accessTokenValidity?: number, refreshTokenValidity?: number, additionalInformation?: string, status?: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限,或者应用拥有 WRITE_CLIENT 权限且 uid 为当前用户并拥有 CREATE_CLIENT 权限) * @summary 创建用户应用 * @param {number} uid * @param {string} name * @param {string} description * @param {string} redirectUri * @param {Array<number>} [scopes] * @param {Array<number>} [grantTypes] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserClient: (uid: number, name: string, description: string, redirectUri: string, scopes?: Array<number>, grantTypes?: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 READ_CLIENT 权限。 * @summary 获取应用 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClient: (cid: string, options?: any) => Promise<RequestArgs>; /** * * @summary 获取应用 Logo * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClientLogo: (cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 READ_CLIENT 权限。 * @summary 查询应用 * @param {string} [q] * @param {Array<string>} [order] * @param {number} [offset] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClients: (q?: string, order?: Array<string>, offset?: number, limit?: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 获取用户应用 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserClient: (uid: number, cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 获取用户应用 Logo * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserClientLogo: (uid: number, cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 查询用户应用 * @param {number} uid * @param {string} [q] * @param {Array<string>} [order] * @param {number} [offset] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserClients: (uid: number, q?: string, order?: Array<string>, offset?: number, limit?: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 删除应用 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeClient: (cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 移除应用成员 * @param {string} cid * @param {Array<number>} uids * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeClientMembers: (cid: string, uids: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 删除应用 * @param {Array<string>} cids * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeClients: (cids: Array<string>, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 删除用户应用 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserClient: (uid: number, cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 移除应用成员 * @param {number} uid * @param {string} cid * @param {Array<number>} uids * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserClientMembers: (uid: number, cid: string, uids: Array<number>, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 READ_CLIENT 权限。 * @summary 删除用户应用 * @param {number} uid * @param {Array<string>} cids * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserClients: (uid: number, cids: Array<string>, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用AccessToken有效期 * @param {string} cid * @param {number} accessTokenValidity * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientAccessTokenValidity: (cid: string, accessTokenValidity: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用描述 * @param {string} cid * @param {string} description * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientDescription: (cid: string, description: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用 Logo * @param {string} cid * @param {any} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientLogo: (cid: string, body: any, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用名称 * @param {string} cid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientName: (cid: string, name: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用回调地址 * @param {string} cid * @param {string} redirectUri * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientRedirectUri: (cid: string, redirectUri: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用RefreshToken有效期 * @param {string} cid * @param {number} refreshTokenValidity * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientRefreshTokenValidity: (cid: string, refreshTokenValidity: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用密钥 * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientSecret: (cid: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 更新应用状态 * @param {string} cid * @param {number} status * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientStatus: (cid: string, status: number, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 更新用户应用描述 * @param {number} uid * @param {string} cid * @param {string} description * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserClientDescription: (uid: number, cid: string, description: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 更新用户应用 Logo * @param {number} uid * @param {string} cid * @param {any} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserClientLogo: (uid: number, cid: string, body: any, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 更新用户应用名称 * @param {number} uid * @param {string} cid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserClientName: (uid: number, cid: string, name: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 更新用户应用回调地址 * @param {number} uid * @param {string} cid * @param {string} redirectUri * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserClientRedirectUri: (uid: number, cid: string, redirectUri: string, options?: any) => Promise<RequestArgs>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 更新用户应用密钥 * @param {number} uid * @param {string} cid * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserClientSecret: (uid: number, cid: string, options?: any) => Promise<RequestArgs>; }; /** * ClientsApi - functional programming interface * @export */ export declare const ClientsApiFp: (configuration?: Configuration) => { /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 添加应用成员 * @param {string} cid * @param {Array<number>} uids * @param {*} [options] Override http request option. * @throws {RequiredError} */ addClientMembers(cid: string, uids: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * 应用和用户(uid 为当前用户除外)需要 WRITE_CLIENT 权限。 * @summary 添加应用成员 * @param {number} uid * @param {string} cid * @param {Array<number>} uids * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserClientMembers(uid: number, cid: string, uids: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * 应用和用户需要 WRITE_CLIENT 权限。 * @summary 创建应用 * @param {number} uid * @param {string} name * @param {string} description * @param {string} redirectUri * @param {Array<number>} [scopes] * @param {Array<number>} [grantTypes] * @param {number} [accessTokenValidity] * @param {number} [refreshTokenValidity] * @param {string