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

1095 lines
54 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 {
RoleRepresentation,
RoleRepresentationFromJSON,
RoleRepresentationToJSON,
} from '../models';
export interface RealmClientScopesIdScopeMappingsClientsClientAvailableGetRequest {
realm: string;
id: string;
client: string;
}
export interface RealmClientScopesIdScopeMappingsClientsClientCompositeGetRequest {
realm: string;
id: string;
client: string;
briefRepresentation?: boolean;
}
export interface RealmClientScopesIdScopeMappingsClientsClientDeleteRequest {
realm: string;
id: string;
client: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientScopesIdScopeMappingsClientsClientGetRequest {
realm: string;
id: string;
client: string;
}
export interface RealmClientScopesIdScopeMappingsClientsClientPostRequest {
realm: string;
id: string;
client: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientScopesIdScopeMappingsRealmAvailableGetRequest {
realm: string;
id: string;
}
export interface RealmClientScopesIdScopeMappingsRealmCompositeGetRequest {
realm: string;
id: string;
briefRepresentation?: boolean;
}
export interface RealmClientScopesIdScopeMappingsRealmDeleteRequest {
realm: string;
id: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientScopesIdScopeMappingsRealmGetRequest {
realm: string;
id: string;
}
export interface RealmClientScopesIdScopeMappingsRealmPostRequest {
realm: string;
id: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientsIdScopeMappingsClientsClientAvailableGetRequest {
realm: string;
id: string;
client: string;
}
export interface RealmClientsIdScopeMappingsClientsClientCompositeGetRequest {
realm: string;
id: string;
client: string;
briefRepresentation?: boolean;
}
export interface RealmClientsIdScopeMappingsClientsClientDeleteRequest {
realm: string;
id: string;
client: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientsIdScopeMappingsClientsClientGetRequest {
realm: string;
id: string;
client: string;
}
export interface RealmClientsIdScopeMappingsClientsClientPostRequest {
realm: string;
id: string;
client: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientsIdScopeMappingsRealmAvailableGetRequest {
realm: string;
id: string;
}
export interface RealmClientsIdScopeMappingsRealmCompositeGetRequest {
realm: string;
id: string;
briefRepresentation?: boolean;
}
export interface RealmClientsIdScopeMappingsRealmDeleteRequest {
realm: string;
id: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientsIdScopeMappingsRealmGetRequest {
realm: string;
id: string;
}
export interface RealmClientsIdScopeMappingsRealmPostRequest {
realm: string;
id: string;
roleRepresentation: Array<RoleRepresentation>;
}
/**
*
*/
export class ScopeMappingsApi extends runtime.BaseAPI {
/**
* The available client-level roles Returns the roles for the client that can be associated with the clients scope
*/
async realmClientScopesIdScopeMappingsClientsClientAvailableGetRaw(requestParameters: RealmClientScopesIdScopeMappingsClientsClientAvailableGetRequest): 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 realmClientScopesIdScopeMappingsClientsClientAvailableGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientAvailableGet.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientAvailableGet.');
}
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}/client-scopes/{id}/scope-mappings/clients/{client}/available`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* The available client-level roles Returns the roles for the client that can be associated with the clients scope
*/
async realmClientScopesIdScopeMappingsClientsClientAvailableGet(requestParameters: RealmClientScopesIdScopeMappingsClientsClientAvailableGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientScopesIdScopeMappingsClientsClientAvailableGetRaw(requestParameters);
return await response.value();
}
/**
* Get effective client roles Returns the roles for the client that are associated with the clients scope.
*/
async realmClientScopesIdScopeMappingsClientsClientCompositeGetRaw(requestParameters: RealmClientScopesIdScopeMappingsClientsClientCompositeGetRequest): 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 realmClientScopesIdScopeMappingsClientsClientCompositeGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientCompositeGet.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientCompositeGet.');
}
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}/client-scopes/{id}/scope-mappings/clients/{client}/composite`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get effective client roles Returns the roles for the client that are associated with the clients scope.
*/
async realmClientScopesIdScopeMappingsClientsClientCompositeGet(requestParameters: RealmClientScopesIdScopeMappingsClientsClientCompositeGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientScopesIdScopeMappingsClientsClientCompositeGetRaw(requestParameters);
return await response.value();
}
/**
* Remove client-level roles from the clients scope.
*/
async realmClientScopesIdScopeMappingsClientsClientDeleteRaw(requestParameters: RealmClientScopesIdScopeMappingsClientsClientDeleteRequest): 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 realmClientScopesIdScopeMappingsClientsClientDelete.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientDelete.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientDelete.');
}
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}/client-scopes/{id}/scope-mappings/clients/{client}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Remove client-level roles from the clients scope.
*/
async realmClientScopesIdScopeMappingsClientsClientDelete(requestParameters: RealmClientScopesIdScopeMappingsClientsClientDeleteRequest): Promise<void> {
await this.realmClientScopesIdScopeMappingsClientsClientDeleteRaw(requestParameters);
}
/**
* Get the roles associated with a clients scope Returns roles for the client.
*/
async realmClientScopesIdScopeMappingsClientsClientGetRaw(requestParameters: RealmClientScopesIdScopeMappingsClientsClientGetRequest): 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 realmClientScopesIdScopeMappingsClientsClientGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientGet.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientGet.');
}
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}/client-scopes/{id}/scope-mappings/clients/{client}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get the roles associated with a clients scope Returns roles for the client.
*/
async realmClientScopesIdScopeMappingsClientsClientGet(requestParameters: RealmClientScopesIdScopeMappingsClientsClientGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientScopesIdScopeMappingsClientsClientGetRaw(requestParameters);
return await response.value();
}
/**
* Add client-level roles to the clients scope
*/
async realmClientScopesIdScopeMappingsClientsClientPostRaw(requestParameters: RealmClientScopesIdScopeMappingsClientsClientPostRequest): 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 realmClientScopesIdScopeMappingsClientsClientPost.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientPost.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientScopesIdScopeMappingsClientsClientPost.');
}
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}/client-scopes/{id}/scope-mappings/clients/{client}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Add client-level roles to the clients scope
*/
async realmClientScopesIdScopeMappingsClientsClientPost(requestParameters: RealmClientScopesIdScopeMappingsClientsClientPostRequest): Promise<void> {
await this.realmClientScopesIdScopeMappingsClientsClientPostRaw(requestParameters);
}
/**
* Get realm-level roles that are available to attach to this clients scope
*/
async realmClientScopesIdScopeMappingsRealmAvailableGetRaw(requestParameters: RealmClientScopesIdScopeMappingsRealmAvailableGetRequest): 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 realmClientScopesIdScopeMappingsRealmAvailableGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsRealmAvailableGet.');
}
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}/client-scopes/{id}/scope-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<any>(response);
}
/**
* Get realm-level roles that are available to attach to this clients scope
*/
async realmClientScopesIdScopeMappingsRealmAvailableGet(requestParameters: RealmClientScopesIdScopeMappingsRealmAvailableGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientScopesIdScopeMappingsRealmAvailableGetRaw(requestParameters);
return await response.value();
}
/**
* Get effective realm-level roles associated with the clients scope What this does is recurse any composite roles associated with the clients scope and adds the roles to this lists.
*/
async realmClientScopesIdScopeMappingsRealmCompositeGetRaw(requestParameters: RealmClientScopesIdScopeMappingsRealmCompositeGetRequest): 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 realmClientScopesIdScopeMappingsRealmCompositeGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsRealmCompositeGet.');
}
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}/client-scopes/{id}/scope-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<any>(response);
}
/**
* Get effective realm-level roles associated with the clients scope What this does is recurse any composite roles associated with the clients scope and adds the roles to this lists.
*/
async realmClientScopesIdScopeMappingsRealmCompositeGet(requestParameters: RealmClientScopesIdScopeMappingsRealmCompositeGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientScopesIdScopeMappingsRealmCompositeGetRaw(requestParameters);
return await response.value();
}
/**
* Remove a set of realm-level roles from the clients scope
*/
async realmClientScopesIdScopeMappingsRealmDeleteRaw(requestParameters: RealmClientScopesIdScopeMappingsRealmDeleteRequest): 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 realmClientScopesIdScopeMappingsRealmDelete.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsRealmDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientScopesIdScopeMappingsRealmDelete.');
}
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}/client-scopes/{id}/scope-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);
}
/**
* Remove a set of realm-level roles from the clients scope
*/
async realmClientScopesIdScopeMappingsRealmDelete(requestParameters: RealmClientScopesIdScopeMappingsRealmDeleteRequest): Promise<void> {
await this.realmClientScopesIdScopeMappingsRealmDeleteRaw(requestParameters);
}
/**
* Get realm-level roles associated with the clients scope
*/
async realmClientScopesIdScopeMappingsRealmGetRaw(requestParameters: RealmClientScopesIdScopeMappingsRealmGetRequest): 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 realmClientScopesIdScopeMappingsRealmGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsRealmGet.');
}
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}/client-scopes/{id}/scope-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get realm-level roles associated with the clients scope
*/
async realmClientScopesIdScopeMappingsRealmGet(requestParameters: RealmClientScopesIdScopeMappingsRealmGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientScopesIdScopeMappingsRealmGetRaw(requestParameters);
return await response.value();
}
/**
* Add a set of realm-level roles to the clients scope
*/
async realmClientScopesIdScopeMappingsRealmPostRaw(requestParameters: RealmClientScopesIdScopeMappingsRealmPostRequest): 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 realmClientScopesIdScopeMappingsRealmPost.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientScopesIdScopeMappingsRealmPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientScopesIdScopeMappingsRealmPost.');
}
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}/client-scopes/{id}/scope-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 a set of realm-level roles to the clients scope
*/
async realmClientScopesIdScopeMappingsRealmPost(requestParameters: RealmClientScopesIdScopeMappingsRealmPostRequest): Promise<void> {
await this.realmClientScopesIdScopeMappingsRealmPostRaw(requestParameters);
}
/**
* The available client-level roles Returns the roles for the client that can be associated with the clients scope
*/
async realmClientsIdScopeMappingsClientsClientAvailableGetRaw(requestParameters: RealmClientsIdScopeMappingsClientsClientAvailableGetRequest): 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 realmClientsIdScopeMappingsClientsClientAvailableGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsClientsClientAvailableGet.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientsIdScopeMappingsClientsClientAvailableGet.');
}
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}/clients/{id}/scope-mappings/clients/{client}/available`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* The available client-level roles Returns the roles for the client that can be associated with the clients scope
*/
async realmClientsIdScopeMappingsClientsClientAvailableGet(requestParameters: RealmClientsIdScopeMappingsClientsClientAvailableGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdScopeMappingsClientsClientAvailableGetRaw(requestParameters);
return await response.value();
}
/**
* Get effective client roles Returns the roles for the client that are associated with the clients scope.
*/
async realmClientsIdScopeMappingsClientsClientCompositeGetRaw(requestParameters: RealmClientsIdScopeMappingsClientsClientCompositeGetRequest): 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 realmClientsIdScopeMappingsClientsClientCompositeGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsClientsClientCompositeGet.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientsIdScopeMappingsClientsClientCompositeGet.');
}
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}/clients/{id}/scope-mappings/clients/{client}/composite`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get effective client roles Returns the roles for the client that are associated with the clients scope.
*/
async realmClientsIdScopeMappingsClientsClientCompositeGet(requestParameters: RealmClientsIdScopeMappingsClientsClientCompositeGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdScopeMappingsClientsClientCompositeGetRaw(requestParameters);
return await response.value();
}
/**
* Remove client-level roles from the clients scope.
*/
async realmClientsIdScopeMappingsClientsClientDeleteRaw(requestParameters: RealmClientsIdScopeMappingsClientsClientDeleteRequest): 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 realmClientsIdScopeMappingsClientsClientDelete.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsClientsClientDelete.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientsIdScopeMappingsClientsClientDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdScopeMappingsClientsClientDelete.');
}
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}/clients/{id}/scope-mappings/clients/{client}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Remove client-level roles from the clients scope.
*/
async realmClientsIdScopeMappingsClientsClientDelete(requestParameters: RealmClientsIdScopeMappingsClientsClientDeleteRequest): Promise<void> {
await this.realmClientsIdScopeMappingsClientsClientDeleteRaw(requestParameters);
}
/**
* Get the roles associated with a clients scope Returns roles for the client.
*/
async realmClientsIdScopeMappingsClientsClientGetRaw(requestParameters: RealmClientsIdScopeMappingsClientsClientGetRequest): 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 realmClientsIdScopeMappingsClientsClientGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsClientsClientGet.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientsIdScopeMappingsClientsClientGet.');
}
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}/clients/{id}/scope-mappings/clients/{client}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get the roles associated with a clients scope Returns roles for the client.
*/
async realmClientsIdScopeMappingsClientsClientGet(requestParameters: RealmClientsIdScopeMappingsClientsClientGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdScopeMappingsClientsClientGetRaw(requestParameters);
return await response.value();
}
/**
* Add client-level roles to the clients scope
*/
async realmClientsIdScopeMappingsClientsClientPostRaw(requestParameters: RealmClientsIdScopeMappingsClientsClientPostRequest): 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 realmClientsIdScopeMappingsClientsClientPost.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsClientsClientPost.');
}
if (requestParameters.client === null || requestParameters.client === undefined) {
throw new runtime.RequiredError('client','Required parameter requestParameters.client was null or undefined when calling realmClientsIdScopeMappingsClientsClientPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdScopeMappingsClientsClientPost.');
}
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}/clients/{id}/scope-mappings/clients/{client}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"client"}}`, encodeURIComponent(String(requestParameters.client))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Add client-level roles to the clients scope
*/
async realmClientsIdScopeMappingsClientsClientPost(requestParameters: RealmClientsIdScopeMappingsClientsClientPostRequest): Promise<void> {
await this.realmClientsIdScopeMappingsClientsClientPostRaw(requestParameters);
}
/**
* Get realm-level roles that are available to attach to this clients scope
*/
async realmClientsIdScopeMappingsRealmAvailableGetRaw(requestParameters: RealmClientsIdScopeMappingsRealmAvailableGetRequest): 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 realmClientsIdScopeMappingsRealmAvailableGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsRealmAvailableGet.');
}
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}/clients/{id}/scope-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<any>(response);
}
/**
* Get realm-level roles that are available to attach to this clients scope
*/
async realmClientsIdScopeMappingsRealmAvailableGet(requestParameters: RealmClientsIdScopeMappingsRealmAvailableGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdScopeMappingsRealmAvailableGetRaw(requestParameters);
return await response.value();
}
/**
* Get effective realm-level roles associated with the clients scope What this does is recurse any composite roles associated with the clients scope and adds the roles to this lists.
*/
async realmClientsIdScopeMappingsRealmCompositeGetRaw(requestParameters: RealmClientsIdScopeMappingsRealmCompositeGetRequest): 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 realmClientsIdScopeMappingsRealmCompositeGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsRealmCompositeGet.');
}
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}/clients/{id}/scope-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<any>(response);
}
/**
* Get effective realm-level roles associated with the clients scope What this does is recurse any composite roles associated with the clients scope and adds the roles to this lists.
*/
async realmClientsIdScopeMappingsRealmCompositeGet(requestParameters: RealmClientsIdScopeMappingsRealmCompositeGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdScopeMappingsRealmCompositeGetRaw(requestParameters);
return await response.value();
}
/**
* Remove a set of realm-level roles from the clients scope
*/
async realmClientsIdScopeMappingsRealmDeleteRaw(requestParameters: RealmClientsIdScopeMappingsRealmDeleteRequest): 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 realmClientsIdScopeMappingsRealmDelete.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsRealmDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdScopeMappingsRealmDelete.');
}
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}/clients/{id}/scope-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);
}
/**
* Remove a set of realm-level roles from the clients scope
*/
async realmClientsIdScopeMappingsRealmDelete(requestParameters: RealmClientsIdScopeMappingsRealmDeleteRequest): Promise<void> {
await this.realmClientsIdScopeMappingsRealmDeleteRaw(requestParameters);
}
/**
* Get realm-level roles associated with the clients scope
*/
async realmClientsIdScopeMappingsRealmGetRaw(requestParameters: RealmClientsIdScopeMappingsRealmGetRequest): 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 realmClientsIdScopeMappingsRealmGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsRealmGet.');
}
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}/clients/{id}/scope-mappings/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get realm-level roles associated with the clients scope
*/
async realmClientsIdScopeMappingsRealmGet(requestParameters: RealmClientsIdScopeMappingsRealmGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdScopeMappingsRealmGetRaw(requestParameters);
return await response.value();
}
/**
* Add a set of realm-level roles to the clients scope
*/
async realmClientsIdScopeMappingsRealmPostRaw(requestParameters: RealmClientsIdScopeMappingsRealmPostRequest): 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 realmClientsIdScopeMappingsRealmPost.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdScopeMappingsRealmPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdScopeMappingsRealmPost.');
}
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}/clients/{id}/scope-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 a set of realm-level roles to the clients scope
*/
async realmClientsIdScopeMappingsRealmPost(requestParameters: RealmClientsIdScopeMappingsRealmPostRequest): Promise<void> {
await this.realmClientsIdScopeMappingsRealmPostRaw(requestParameters);
}
}