/* tslint:disable */ /* eslint-disable */ /** * Keycloak Admin REST API * This is a REST API reference for the Keycloak Admin * * The version of the OpenAPI document: 1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { MappingsRepresentation, MappingsRepresentationFromJSON, MappingsRepresentationToJSON, RoleRepresentation, RoleRepresentationFromJSON, RoleRepresentationToJSON, } from '../models'; export interface RealmGroupsIdRoleMappingsGetRequest { realm: string; id: string; } export interface RealmGroupsIdRoleMappingsRealmAvailableGetRequest { realm: string; id: string; } export interface RealmGroupsIdRoleMappingsRealmCompositeGetRequest { realm: string; id: string; briefRepresentation?: boolean; } export interface RealmGroupsIdRoleMappingsRealmDeleteRequest { realm: string; id: string; roleRepresentation: Array; } export interface RealmGroupsIdRoleMappingsRealmGetRequest { realm: string; id: string; } export interface RealmGroupsIdRoleMappingsRealmPostRequest { realm: string; id: string; roleRepresentation: Array; } export interface RealmUsersIdRoleMappingsGetRequest { realm: string; id: string; } export interface RealmUsersIdRoleMappingsRealmAvailableGetRequest { realm: string; id: string; } export interface RealmUsersIdRoleMappingsRealmCompositeGetRequest { realm: string; id: string; briefRepresentation?: boolean; } export interface RealmUsersIdRoleMappingsRealmDeleteRequest { realm: string; id: string; roleRepresentation: Array; } export interface RealmUsersIdRoleMappingsRealmGetRequest { realm: string; id: string; } export interface RealmUsersIdRoleMappingsRealmPostRequest { realm: string; id: string; roleRepresentation: Array; } /** * */ export class RoleMapperApi extends runtime.BaseAPI { /** * Get role mappings */ async realmGroupsIdRoleMappingsGetRaw(requestParameters: RealmGroupsIdRoleMappingsGetRequest): Promise> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmGroupsIdRoleMappingsGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmGroupsIdRoleMappingsGet.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/groups/{id}/role-mappings`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response, (jsonValue) => MappingsRepresentationFromJSON(jsonValue)); } /** * Get role mappings */ async realmGroupsIdRoleMappingsGet(requestParameters: RealmGroupsIdRoleMappingsGetRequest): Promise { const response = await this.realmGroupsIdRoleMappingsGetRaw(requestParameters); return await response.value(); } /** * Get realm-level roles that can be mapped */ async realmGroupsIdRoleMappingsRealmAvailableGetRaw(requestParameters: RealmGroupsIdRoleMappingsRealmAvailableGetRequest): Promise>> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmGroupsIdRoleMappingsRealmAvailableGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmGroupsIdRoleMappingsRealmAvailableGet.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/groups/{id}/role-mappings/realm/available`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response); } /** * Get realm-level roles that can be mapped */ async realmGroupsIdRoleMappingsRealmAvailableGet(requestParameters: RealmGroupsIdRoleMappingsRealmAvailableGetRequest): Promise> { const response = await this.realmGroupsIdRoleMappingsRealmAvailableGetRaw(requestParameters); return await response.value(); } /** * Get effective realm-level role mappings This will recurse all composite roles to get the result. */ async realmGroupsIdRoleMappingsRealmCompositeGetRaw(requestParameters: RealmGroupsIdRoleMappingsRealmCompositeGetRequest): Promise>> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmGroupsIdRoleMappingsRealmCompositeGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmGroupsIdRoleMappingsRealmCompositeGet.'); } const queryParameters: runtime.HTTPQuery = {}; if (requestParameters.briefRepresentation !== undefined) { queryParameters['briefRepresentation'] = requestParameters.briefRepresentation; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/groups/{id}/role-mappings/realm/composite`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response); } /** * Get effective realm-level role mappings This will recurse all composite roles to get the result. */ async realmGroupsIdRoleMappingsRealmCompositeGet(requestParameters: RealmGroupsIdRoleMappingsRealmCompositeGetRequest): Promise> { const response = await this.realmGroupsIdRoleMappingsRealmCompositeGetRaw(requestParameters); return await response.value(); } /** * Delete realm-level role mappings */ async realmGroupsIdRoleMappingsRealmDeleteRaw(requestParameters: RealmGroupsIdRoleMappingsRealmDeleteRequest): Promise> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmGroupsIdRoleMappingsRealmDelete.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmGroupsIdRoleMappingsRealmDelete.'); } if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) { throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmGroupsIdRoleMappingsRealmDelete.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/groups/{id}/role-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'DELETE', headers: headerParameters, query: queryParameters, body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON), }); return new runtime.VoidApiResponse(response); } /** * Delete realm-level role mappings */ async realmGroupsIdRoleMappingsRealmDelete(requestParameters: RealmGroupsIdRoleMappingsRealmDeleteRequest): Promise { await this.realmGroupsIdRoleMappingsRealmDeleteRaw(requestParameters); } /** * Get realm-level role mappings */ async realmGroupsIdRoleMappingsRealmGetRaw(requestParameters: RealmGroupsIdRoleMappingsRealmGetRequest): Promise>> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmGroupsIdRoleMappingsRealmGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmGroupsIdRoleMappingsRealmGet.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/groups/{id}/role-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response); } /** * Get realm-level role mappings */ async realmGroupsIdRoleMappingsRealmGet(requestParameters: RealmGroupsIdRoleMappingsRealmGetRequest): Promise> { const response = await this.realmGroupsIdRoleMappingsRealmGetRaw(requestParameters); return await response.value(); } /** * Add realm-level role mappings to the user */ async realmGroupsIdRoleMappingsRealmPostRaw(requestParameters: RealmGroupsIdRoleMappingsRealmPostRequest): Promise> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmGroupsIdRoleMappingsRealmPost.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmGroupsIdRoleMappingsRealmPost.'); } if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) { throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmGroupsIdRoleMappingsRealmPost.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/groups/{id}/role-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON), }); return new runtime.VoidApiResponse(response); } /** * Add realm-level role mappings to the user */ async realmGroupsIdRoleMappingsRealmPost(requestParameters: RealmGroupsIdRoleMappingsRealmPostRequest): Promise { await this.realmGroupsIdRoleMappingsRealmPostRaw(requestParameters); } /** * Get role mappings */ async realmUsersIdRoleMappingsGetRaw(requestParameters: RealmUsersIdRoleMappingsGetRequest): Promise> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmUsersIdRoleMappingsGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmUsersIdRoleMappingsGet.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/users/{id}/role-mappings`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response, (jsonValue) => MappingsRepresentationFromJSON(jsonValue)); } /** * Get role mappings */ async realmUsersIdRoleMappingsGet(requestParameters: RealmUsersIdRoleMappingsGetRequest): Promise { const response = await this.realmUsersIdRoleMappingsGetRaw(requestParameters); return await response.value(); } /** * Get realm-level roles that can be mapped */ async realmUsersIdRoleMappingsRealmAvailableGetRaw(requestParameters: RealmUsersIdRoleMappingsRealmAvailableGetRequest): Promise>> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmUsersIdRoleMappingsRealmAvailableGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmUsersIdRoleMappingsRealmAvailableGet.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/users/{id}/role-mappings/realm/available`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response); } /** * Get realm-level roles that can be mapped */ async realmUsersIdRoleMappingsRealmAvailableGet(requestParameters: RealmUsersIdRoleMappingsRealmAvailableGetRequest): Promise> { const response = await this.realmUsersIdRoleMappingsRealmAvailableGetRaw(requestParameters); return await response.value(); } /** * Get effective realm-level role mappings This will recurse all composite roles to get the result. */ async realmUsersIdRoleMappingsRealmCompositeGetRaw(requestParameters: RealmUsersIdRoleMappingsRealmCompositeGetRequest): Promise>> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmUsersIdRoleMappingsRealmCompositeGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmUsersIdRoleMappingsRealmCompositeGet.'); } const queryParameters: runtime.HTTPQuery = {}; if (requestParameters.briefRepresentation !== undefined) { queryParameters['briefRepresentation'] = requestParameters.briefRepresentation; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/users/{id}/role-mappings/realm/composite`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response); } /** * Get effective realm-level role mappings This will recurse all composite roles to get the result. */ async realmUsersIdRoleMappingsRealmCompositeGet(requestParameters: RealmUsersIdRoleMappingsRealmCompositeGetRequest): Promise> { const response = await this.realmUsersIdRoleMappingsRealmCompositeGetRaw(requestParameters); return await response.value(); } /** * Delete realm-level role mappings */ async realmUsersIdRoleMappingsRealmDeleteRaw(requestParameters: RealmUsersIdRoleMappingsRealmDeleteRequest): Promise> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmUsersIdRoleMappingsRealmDelete.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmUsersIdRoleMappingsRealmDelete.'); } if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) { throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmUsersIdRoleMappingsRealmDelete.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/users/{id}/role-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'DELETE', headers: headerParameters, query: queryParameters, body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON), }); return new runtime.VoidApiResponse(response); } /** * Delete realm-level role mappings */ async realmUsersIdRoleMappingsRealmDelete(requestParameters: RealmUsersIdRoleMappingsRealmDeleteRequest): Promise { await this.realmUsersIdRoleMappingsRealmDeleteRaw(requestParameters); } /** * Get realm-level role mappings */ async realmUsersIdRoleMappingsRealmGetRaw(requestParameters: RealmUsersIdRoleMappingsRealmGetRequest): Promise>> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmUsersIdRoleMappingsRealmGet.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmUsersIdRoleMappingsRealmGet.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/users/{id}/role-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'GET', headers: headerParameters, query: queryParameters, }); return new runtime.JSONApiResponse(response); } /** * Get realm-level role mappings */ async realmUsersIdRoleMappingsRealmGet(requestParameters: RealmUsersIdRoleMappingsRealmGetRequest): Promise> { const response = await this.realmUsersIdRoleMappingsRealmGetRaw(requestParameters); return await response.value(); } /** * Add realm-level role mappings to the user */ async realmUsersIdRoleMappingsRealmPostRaw(requestParameters: RealmUsersIdRoleMappingsRealmPostRequest): Promise> { if (requestParameters.realm === null || requestParameters.realm === undefined) { throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmUsersIdRoleMappingsRealmPost.'); } if (requestParameters.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmUsersIdRoleMappingsRealmPost.'); } if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) { throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmUsersIdRoleMappingsRealmPost.'); } const queryParameters: runtime.HTTPQuery = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = typeof token === 'function' ? token("access_token", []) : token; if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/{realm}/users/{id}/role-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))), method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON), }); return new runtime.VoidApiResponse(response); } /** * Add realm-level role mappings to the user */ async realmUsersIdRoleMappingsRealmPost(requestParameters: RealmUsersIdRoleMappingsRealmPostRequest): Promise { await this.realmUsersIdRoleMappingsRealmPostRaw(requestParameters); } }