Files
auth/backend/keycloak/kc-client/apis/RolesByIDApi.ts
2022-09-05 17:02:45 +02:00

550 lines
25 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/* 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 {
ManagementPermissionReference,
ManagementPermissionReferenceFromJSON,
ManagementPermissionReferenceToJSON,
RoleRepresentation,
RoleRepresentationFromJSON,
RoleRepresentationToJSON,
} from '../models';
export interface RealmRolesByIdRoleIdCompositesClientsClientUuidGetRequest {
realm: string;
roleId: string;
clientUuid: string;
}
export interface RealmRolesByIdRoleIdCompositesDeleteRequest {
realm: string;
roleId: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmRolesByIdRoleIdCompositesGetRequest {
realm: string;
roleId: string;
first?: number;
max?: number;
search?: string;
}
export interface RealmRolesByIdRoleIdCompositesPostRequest {
realm: string;
roleId: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmRolesByIdRoleIdCompositesRealmGetRequest {
realm: string;
roleId: string;
}
export interface RealmRolesByIdRoleIdDeleteRequest {
realm: string;
roleId: string;
}
export interface RealmRolesByIdRoleIdGetRequest {
realm: string;
roleId: string;
}
export interface RealmRolesByIdRoleIdManagementPermissionsGetRequest {
realm: string;
roleId: string;
}
export interface RealmRolesByIdRoleIdManagementPermissionsPutRequest {
realm: string;
roleId: string;
managementPermissionReference: ManagementPermissionReference;
}
export interface RealmRolesByIdRoleIdPutRequest {
realm: string;
roleId: string;
roleRepresentation: RoleRepresentation;
}
/**
*
*/
export class RolesByIDApi extends runtime.BaseAPI {
/**
* Get client-level roles for the client that are in the roles composite
*/
async realmRolesByIdRoleIdCompositesClientsClientUuidGetRaw(requestParameters: RealmRolesByIdRoleIdCompositesClientsClientUuidGetRequest): Promise<runtime.ApiResponse<Array<{ [key: string]: object; }>>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdCompositesClientsClientUuidGet.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdCompositesClientsClientUuidGet.');
}
if (requestParameters.clientUuid === null || requestParameters.clientUuid === undefined) {
throw new runtime.RequiredError('clientUuid','Required parameter requestParameters.clientUuid was null or undefined when calling realmRolesByIdRoleIdCompositesClientsClientUuidGet.');
}
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}/roles-by-id/{role-id}/composites/clients/{clientUuid}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))).replace(`{${"clientUuid"}}`, encodeURIComponent(String(requestParameters.clientUuid))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get client-level roles for the client that are in the roles composite
*/
async realmRolesByIdRoleIdCompositesClientsClientUuidGet(requestParameters: RealmRolesByIdRoleIdCompositesClientsClientUuidGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesByIdRoleIdCompositesClientsClientUuidGetRaw(requestParameters);
return await response.value();
}
/**
* Remove a set of roles from the roles composite
*/
async realmRolesByIdRoleIdCompositesDeleteRaw(requestParameters: RealmRolesByIdRoleIdCompositesDeleteRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdCompositesDelete.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdCompositesDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesByIdRoleIdCompositesDelete.');
}
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}/roles-by-id/{role-id}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Remove a set of roles from the roles composite
*/
async realmRolesByIdRoleIdCompositesDelete(requestParameters: RealmRolesByIdRoleIdCompositesDeleteRequest): Promise<void> {
await this.realmRolesByIdRoleIdCompositesDeleteRaw(requestParameters);
}
/**
* Get roles children Returns a set of roles children provided the role is a composite.
*/
async realmRolesByIdRoleIdCompositesGetRaw(requestParameters: RealmRolesByIdRoleIdCompositesGetRequest): Promise<runtime.ApiResponse<Array<{ [key: string]: object; }>>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdCompositesGet.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdCompositesGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.first !== undefined) {
queryParameters['first'] = requestParameters.first;
}
if (requestParameters.max !== undefined) {
queryParameters['max'] = requestParameters.max;
}
if (requestParameters.search !== undefined) {
queryParameters['search'] = requestParameters.search;
}
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}/roles-by-id/{role-id}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get roles children Returns a set of roles children provided the role is a composite.
*/
async realmRolesByIdRoleIdCompositesGet(requestParameters: RealmRolesByIdRoleIdCompositesGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesByIdRoleIdCompositesGetRaw(requestParameters);
return await response.value();
}
/**
* Make the role a composite role by associating some child roles
*/
async realmRolesByIdRoleIdCompositesPostRaw(requestParameters: RealmRolesByIdRoleIdCompositesPostRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdCompositesPost.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdCompositesPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesByIdRoleIdCompositesPost.');
}
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}/roles-by-id/{role-id}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Make the role a composite role by associating some child roles
*/
async realmRolesByIdRoleIdCompositesPost(requestParameters: RealmRolesByIdRoleIdCompositesPostRequest): Promise<void> {
await this.realmRolesByIdRoleIdCompositesPostRaw(requestParameters);
}
/**
* Get realm-level roles that are in the roles composite
*/
async realmRolesByIdRoleIdCompositesRealmGetRaw(requestParameters: RealmRolesByIdRoleIdCompositesRealmGetRequest): Promise<runtime.ApiResponse<Array<{ [key: string]: object; }>>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdCompositesRealmGet.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdCompositesRealmGet.');
}
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}/roles-by-id/{role-id}/composites/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get realm-level roles that are in the roles composite
*/
async realmRolesByIdRoleIdCompositesRealmGet(requestParameters: RealmRolesByIdRoleIdCompositesRealmGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesByIdRoleIdCompositesRealmGetRaw(requestParameters);
return await response.value();
}
/**
* Delete the role
*/
async realmRolesByIdRoleIdDeleteRaw(requestParameters: RealmRolesByIdRoleIdDeleteRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdDelete.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdDelete.');
}
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}/roles-by-id/{role-id}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
});
return new runtime.VoidApiResponse(response);
}
/**
* Delete the role
*/
async realmRolesByIdRoleIdDelete(requestParameters: RealmRolesByIdRoleIdDeleteRequest): Promise<void> {
await this.realmRolesByIdRoleIdDeleteRaw(requestParameters);
}
/**
* Get a specific roles representation
*/
async realmRolesByIdRoleIdGetRaw(requestParameters: RealmRolesByIdRoleIdGetRequest): Promise<runtime.ApiResponse<RoleRepresentation>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdGet.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdGet.');
}
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}/roles-by-id/{role-id}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => RoleRepresentationFromJSON(jsonValue));
}
/**
* Get a specific roles representation
*/
async realmRolesByIdRoleIdGet(requestParameters: RealmRolesByIdRoleIdGetRequest): Promise<RoleRepresentation> {
const response = await this.realmRolesByIdRoleIdGetRaw(requestParameters);
return await response.value();
}
/**
* Return object stating whether role Authoirzation permissions have been initialized or not and a reference
*/
async realmRolesByIdRoleIdManagementPermissionsGetRaw(requestParameters: RealmRolesByIdRoleIdManagementPermissionsGetRequest): Promise<runtime.ApiResponse<ManagementPermissionReference>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdManagementPermissionsGet.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdManagementPermissionsGet.');
}
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}/roles-by-id/{role-id}/management/permissions`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => ManagementPermissionReferenceFromJSON(jsonValue));
}
/**
* Return object stating whether role Authoirzation permissions have been initialized or not and a reference
*/
async realmRolesByIdRoleIdManagementPermissionsGet(requestParameters: RealmRolesByIdRoleIdManagementPermissionsGetRequest): Promise<ManagementPermissionReference> {
const response = await this.realmRolesByIdRoleIdManagementPermissionsGetRaw(requestParameters);
return await response.value();
}
/**
* Return object stating whether role Authoirzation permissions have been initialized or not and a reference
*/
async realmRolesByIdRoleIdManagementPermissionsPutRaw(requestParameters: RealmRolesByIdRoleIdManagementPermissionsPutRequest): Promise<runtime.ApiResponse<ManagementPermissionReference>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdManagementPermissionsPut.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdManagementPermissionsPut.');
}
if (requestParameters.managementPermissionReference === null || requestParameters.managementPermissionReference === undefined) {
throw new runtime.RequiredError('managementPermissionReference','Required parameter requestParameters.managementPermissionReference was null or undefined when calling realmRolesByIdRoleIdManagementPermissionsPut.');
}
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}/roles-by-id/{role-id}/management/permissions`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: ManagementPermissionReferenceToJSON(requestParameters.managementPermissionReference),
});
return new runtime.JSONApiResponse(response, (jsonValue) => ManagementPermissionReferenceFromJSON(jsonValue));
}
/**
* Return object stating whether role Authoirzation permissions have been initialized or not and a reference
*/
async realmRolesByIdRoleIdManagementPermissionsPut(requestParameters: RealmRolesByIdRoleIdManagementPermissionsPutRequest): Promise<ManagementPermissionReference> {
const response = await this.realmRolesByIdRoleIdManagementPermissionsPutRaw(requestParameters);
return await response.value();
}
/**
* Update the role
*/
async realmRolesByIdRoleIdPutRaw(requestParameters: RealmRolesByIdRoleIdPutRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.realm === null || requestParameters.realm === undefined) {
throw new runtime.RequiredError('realm','Required parameter requestParameters.realm was null or undefined when calling realmRolesByIdRoleIdPut.');
}
if (requestParameters.roleId === null || requestParameters.roleId === undefined) {
throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling realmRolesByIdRoleIdPut.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesByIdRoleIdPut.');
}
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}/roles-by-id/{role-id}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-id"}}`, encodeURIComponent(String(requestParameters.roleId))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: RoleRepresentationToJSON(requestParameters.roleRepresentation),
});
return new runtime.VoidApiResponse(response);
}
/**
* Update the role
*/
async realmRolesByIdRoleIdPut(requestParameters: RealmRolesByIdRoleIdPutRequest): Promise<void> {
await this.realmRolesByIdRoleIdPutRaw(requestParameters);
}
}