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

1568 lines
72 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 RealmClientsIdRolesGetRequest {
realm: string;
id: string;
briefRepresentation?: boolean;
first?: number;
max?: number;
search?: string;
}
export interface RealmClientsIdRolesPostRequest {
realm: string;
id: string;
roleRepresentation: RoleRepresentation;
}
export interface RealmClientsIdRolesRoleNameCompositesClientsClientUuidGetRequest {
realm: string;
id: string;
roleName: string;
clientUuid: string;
}
export interface RealmClientsIdRolesRoleNameCompositesDeleteRequest {
realm: string;
id: string;
roleName: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientsIdRolesRoleNameCompositesGetRequest {
realm: string;
id: string;
roleName: string;
}
export interface RealmClientsIdRolesRoleNameCompositesPostRequest {
realm: string;
id: string;
roleName: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmClientsIdRolesRoleNameCompositesRealmGetRequest {
realm: string;
id: string;
roleName: string;
}
export interface RealmClientsIdRolesRoleNameDeleteRequest {
realm: string;
id: string;
roleName: string;
}
export interface RealmClientsIdRolesRoleNameGetRequest {
realm: string;
id: string;
roleName: string;
}
export interface RealmClientsIdRolesRoleNameGroupsGetRequest {
realm: string;
id: string;
roleName: string;
briefRepresentation?: boolean;
first?: number;
max?: number;
}
export interface RealmClientsIdRolesRoleNameManagementPermissionsGetRequest {
realm: string;
id: string;
roleName: string;
}
export interface RealmClientsIdRolesRoleNameManagementPermissionsPutRequest {
realm: string;
id: string;
roleName: string;
managementPermissionReference: ManagementPermissionReference;
}
export interface RealmClientsIdRolesRoleNamePutRequest {
realm: string;
id: string;
roleName: string;
roleRepresentation: RoleRepresentation;
}
export interface RealmClientsIdRolesRoleNameUsersGetRequest {
realm: string;
id: string;
roleName: string;
first?: number;
max?: number;
}
export interface RealmRolesGetRequest {
realm: string;
briefRepresentation?: boolean;
first?: number;
max?: number;
search?: string;
}
export interface RealmRolesPostRequest {
realm: string;
roleRepresentation: RoleRepresentation;
}
export interface RealmRolesRoleNameCompositesClientsClientUuidGetRequest {
realm: string;
roleName: string;
clientUuid: string;
}
export interface RealmRolesRoleNameCompositesDeleteRequest {
realm: string;
roleName: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmRolesRoleNameCompositesGetRequest {
realm: string;
roleName: string;
}
export interface RealmRolesRoleNameCompositesPostRequest {
realm: string;
roleName: string;
roleRepresentation: Array<RoleRepresentation>;
}
export interface RealmRolesRoleNameCompositesRealmGetRequest {
realm: string;
roleName: string;
}
export interface RealmRolesRoleNameDeleteRequest {
realm: string;
roleName: string;
}
export interface RealmRolesRoleNameGetRequest {
realm: string;
roleName: string;
}
export interface RealmRolesRoleNameGroupsGetRequest {
realm: string;
roleName: string;
briefRepresentation?: boolean;
first?: number;
max?: number;
}
export interface RealmRolesRoleNameManagementPermissionsGetRequest {
realm: string;
roleName: string;
}
export interface RealmRolesRoleNameManagementPermissionsPutRequest {
realm: string;
roleName: string;
managementPermissionReference: ManagementPermissionReference;
}
export interface RealmRolesRoleNamePutRequest {
realm: string;
roleName: string;
roleRepresentation: RoleRepresentation;
}
export interface RealmRolesRoleNameUsersGetRequest {
realm: string;
roleName: string;
first?: number;
max?: number;
}
/**
*
*/
export class RolesApi extends runtime.BaseAPI {
/**
* Get all roles for the realm or client
*/
async realmClientsIdRolesGetRaw(requestParameters: RealmClientsIdRolesGetRequest): 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 realmClientsIdRolesGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.briefRepresentation !== undefined) {
queryParameters['briefRepresentation'] = requestParameters.briefRepresentation;
}
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}/clients/{id}/roles`.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 all roles for the realm or client
*/
async realmClientsIdRolesGet(requestParameters: RealmClientsIdRolesGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdRolesGetRaw(requestParameters);
return await response.value();
}
/**
* Create a new role for the realm or client
*/
async realmClientsIdRolesPostRaw(requestParameters: RealmClientsIdRolesPostRequest): 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 realmClientsIdRolesPost.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdRolesPost.');
}
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}/roles`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: RoleRepresentationToJSON(requestParameters.roleRepresentation),
});
return new runtime.VoidApiResponse(response);
}
/**
* Create a new role for the realm or client
*/
async realmClientsIdRolesPost(requestParameters: RealmClientsIdRolesPostRequest): Promise<void> {
await this.realmClientsIdRolesPostRaw(requestParameters);
}
/**
* Get client-level roles for the client that are in the roles composite
*/
async realmClientsIdRolesRoleNameCompositesClientsClientUuidGetRaw(requestParameters: RealmClientsIdRolesRoleNameCompositesClientsClientUuidGetRequest): 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 realmClientsIdRolesRoleNameCompositesClientsClientUuidGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameCompositesClientsClientUuidGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameCompositesClientsClientUuidGet.');
}
if (requestParameters.clientUuid === null || requestParameters.clientUuid === undefined) {
throw new runtime.RequiredError('clientUuid','Required parameter requestParameters.clientUuid was null or undefined when calling realmClientsIdRolesRoleNameCompositesClientsClientUuidGet.');
}
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}/roles/{role-name}/composites/clients/{clientUuid}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))).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 realmClientsIdRolesRoleNameCompositesClientsClientUuidGet(requestParameters: RealmClientsIdRolesRoleNameCompositesClientsClientUuidGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdRolesRoleNameCompositesClientsClientUuidGetRaw(requestParameters);
return await response.value();
}
/**
* Remove roles from the roles composite
*/
async realmClientsIdRolesRoleNameCompositesDeleteRaw(requestParameters: RealmClientsIdRolesRoleNameCompositesDeleteRequest): 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 realmClientsIdRolesRoleNameCompositesDelete.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameCompositesDelete.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameCompositesDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdRolesRoleNameCompositesDelete.');
}
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}/roles/{role-name}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Remove roles from the roles composite
*/
async realmClientsIdRolesRoleNameCompositesDelete(requestParameters: RealmClientsIdRolesRoleNameCompositesDeleteRequest): Promise<void> {
await this.realmClientsIdRolesRoleNameCompositesDeleteRaw(requestParameters);
}
/**
* Get composites of the role
*/
async realmClientsIdRolesRoleNameCompositesGetRaw(requestParameters: RealmClientsIdRolesRoleNameCompositesGetRequest): 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 realmClientsIdRolesRoleNameCompositesGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameCompositesGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameCompositesGet.');
}
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}/roles/{role-name}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get composites of the role
*/
async realmClientsIdRolesRoleNameCompositesGet(requestParameters: RealmClientsIdRolesRoleNameCompositesGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdRolesRoleNameCompositesGetRaw(requestParameters);
return await response.value();
}
/**
* Add a composite to the role
*/
async realmClientsIdRolesRoleNameCompositesPostRaw(requestParameters: RealmClientsIdRolesRoleNameCompositesPostRequest): 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 realmClientsIdRolesRoleNameCompositesPost.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameCompositesPost.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameCompositesPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdRolesRoleNameCompositesPost.');
}
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}/roles/{role-name}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Add a composite to the role
*/
async realmClientsIdRolesRoleNameCompositesPost(requestParameters: RealmClientsIdRolesRoleNameCompositesPostRequest): Promise<void> {
await this.realmClientsIdRolesRoleNameCompositesPostRaw(requestParameters);
}
/**
* Get realm-level roles of the roles composite
*/
async realmClientsIdRolesRoleNameCompositesRealmGetRaw(requestParameters: RealmClientsIdRolesRoleNameCompositesRealmGetRequest): 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 realmClientsIdRolesRoleNameCompositesRealmGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameCompositesRealmGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameCompositesRealmGet.');
}
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}/roles/{role-name}/composites/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get realm-level roles of the roles composite
*/
async realmClientsIdRolesRoleNameCompositesRealmGet(requestParameters: RealmClientsIdRolesRoleNameCompositesRealmGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdRolesRoleNameCompositesRealmGetRaw(requestParameters);
return await response.value();
}
/**
* Delete a role by name
*/
async realmClientsIdRolesRoleNameDeleteRaw(requestParameters: RealmClientsIdRolesRoleNameDeleteRequest): 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 realmClientsIdRolesRoleNameDelete.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameDelete.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameDelete.');
}
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}/roles/{role-name}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
});
return new runtime.VoidApiResponse(response);
}
/**
* Delete a role by name
*/
async realmClientsIdRolesRoleNameDelete(requestParameters: RealmClientsIdRolesRoleNameDeleteRequest): Promise<void> {
await this.realmClientsIdRolesRoleNameDeleteRaw(requestParameters);
}
/**
* Get a role by name
*/
async realmClientsIdRolesRoleNameGetRaw(requestParameters: RealmClientsIdRolesRoleNameGetRequest): 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 realmClientsIdRolesRoleNameGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameGet.');
}
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}/roles/{role-name}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => RoleRepresentationFromJSON(jsonValue));
}
/**
* Get a role by name
*/
async realmClientsIdRolesRoleNameGet(requestParameters: RealmClientsIdRolesRoleNameGetRequest): Promise<RoleRepresentation> {
const response = await this.realmClientsIdRolesRoleNameGetRaw(requestParameters);
return await response.value();
}
/**
* Returns a stream of groups that have the specified role name
*/
async realmClientsIdRolesRoleNameGroupsGetRaw(requestParameters: RealmClientsIdRolesRoleNameGroupsGetRequest): 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 realmClientsIdRolesRoleNameGroupsGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameGroupsGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameGroupsGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.briefRepresentation !== undefined) {
queryParameters['briefRepresentation'] = requestParameters.briefRepresentation;
}
if (requestParameters.first !== undefined) {
queryParameters['first'] = requestParameters.first;
}
if (requestParameters.max !== undefined) {
queryParameters['max'] = requestParameters.max;
}
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}/roles/{role-name}/groups`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Returns a stream of groups that have the specified role name
*/
async realmClientsIdRolesRoleNameGroupsGet(requestParameters: RealmClientsIdRolesRoleNameGroupsGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdRolesRoleNameGroupsGetRaw(requestParameters);
return await response.value();
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmClientsIdRolesRoleNameManagementPermissionsGetRaw(requestParameters: RealmClientsIdRolesRoleNameManagementPermissionsGetRequest): 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 realmClientsIdRolesRoleNameManagementPermissionsGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameManagementPermissionsGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameManagementPermissionsGet.');
}
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}/roles/{role-name}/management/permissions`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => ManagementPermissionReferenceFromJSON(jsonValue));
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmClientsIdRolesRoleNameManagementPermissionsGet(requestParameters: RealmClientsIdRolesRoleNameManagementPermissionsGetRequest): Promise<ManagementPermissionReference> {
const response = await this.realmClientsIdRolesRoleNameManagementPermissionsGetRaw(requestParameters);
return await response.value();
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmClientsIdRolesRoleNameManagementPermissionsPutRaw(requestParameters: RealmClientsIdRolesRoleNameManagementPermissionsPutRequest): 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 realmClientsIdRolesRoleNameManagementPermissionsPut.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameManagementPermissionsPut.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameManagementPermissionsPut.');
}
if (requestParameters.managementPermissionReference === null || requestParameters.managementPermissionReference === undefined) {
throw new runtime.RequiredError('managementPermissionReference','Required parameter requestParameters.managementPermissionReference was null or undefined when calling realmClientsIdRolesRoleNameManagementPermissionsPut.');
}
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}/roles/{role-name}/management/permissions`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: ManagementPermissionReferenceToJSON(requestParameters.managementPermissionReference),
});
return new runtime.JSONApiResponse(response, (jsonValue) => ManagementPermissionReferenceFromJSON(jsonValue));
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmClientsIdRolesRoleNameManagementPermissionsPut(requestParameters: RealmClientsIdRolesRoleNameManagementPermissionsPutRequest): Promise<ManagementPermissionReference> {
const response = await this.realmClientsIdRolesRoleNameManagementPermissionsPutRaw(requestParameters);
return await response.value();
}
/**
* Update a role by name
*/
async realmClientsIdRolesRoleNamePutRaw(requestParameters: RealmClientsIdRolesRoleNamePutRequest): 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 realmClientsIdRolesRoleNamePut.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNamePut.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNamePut.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmClientsIdRolesRoleNamePut.');
}
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}/roles/{role-name}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: RoleRepresentationToJSON(requestParameters.roleRepresentation),
});
return new runtime.VoidApiResponse(response);
}
/**
* Update a role by name
*/
async realmClientsIdRolesRoleNamePut(requestParameters: RealmClientsIdRolesRoleNamePutRequest): Promise<void> {
await this.realmClientsIdRolesRoleNamePutRaw(requestParameters);
}
/**
* Returns a stream of users that have the specified role name.
*/
async realmClientsIdRolesRoleNameUsersGetRaw(requestParameters: RealmClientsIdRolesRoleNameUsersGetRequest): 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 realmClientsIdRolesRoleNameUsersGet.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling realmClientsIdRolesRoleNameUsersGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmClientsIdRolesRoleNameUsersGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.first !== undefined) {
queryParameters['first'] = requestParameters.first;
}
if (requestParameters.max !== undefined) {
queryParameters['max'] = requestParameters.max;
}
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}/roles/{role-name}/users`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Returns a stream of users that have the specified role name.
*/
async realmClientsIdRolesRoleNameUsersGet(requestParameters: RealmClientsIdRolesRoleNameUsersGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmClientsIdRolesRoleNameUsersGetRaw(requestParameters);
return await response.value();
}
/**
* Get all roles for the realm or client
*/
async realmRolesGetRaw(requestParameters: RealmRolesGetRequest): 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 realmRolesGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.briefRepresentation !== undefined) {
queryParameters['briefRepresentation'] = requestParameters.briefRepresentation;
}
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`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get all roles for the realm or client
*/
async realmRolesGet(requestParameters: RealmRolesGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesGetRaw(requestParameters);
return await response.value();
}
/**
* Create a new role for the realm or client
*/
async realmRolesPostRaw(requestParameters: RealmRolesPostRequest): 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 realmRolesPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesPost.');
}
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`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: RoleRepresentationToJSON(requestParameters.roleRepresentation),
});
return new runtime.VoidApiResponse(response);
}
/**
* Create a new role for the realm or client
*/
async realmRolesPost(requestParameters: RealmRolesPostRequest): Promise<void> {
await this.realmRolesPostRaw(requestParameters);
}
/**
* Get client-level roles for the client that are in the roles composite
*/
async realmRolesRoleNameCompositesClientsClientUuidGetRaw(requestParameters: RealmRolesRoleNameCompositesClientsClientUuidGetRequest): 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 realmRolesRoleNameCompositesClientsClientUuidGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameCompositesClientsClientUuidGet.');
}
if (requestParameters.clientUuid === null || requestParameters.clientUuid === undefined) {
throw new runtime.RequiredError('clientUuid','Required parameter requestParameters.clientUuid was null or undefined when calling realmRolesRoleNameCompositesClientsClientUuidGet.');
}
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/{role-name}/composites/clients/{clientUuid}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))).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 realmRolesRoleNameCompositesClientsClientUuidGet(requestParameters: RealmRolesRoleNameCompositesClientsClientUuidGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesRoleNameCompositesClientsClientUuidGetRaw(requestParameters);
return await response.value();
}
/**
* Remove roles from the roles composite
*/
async realmRolesRoleNameCompositesDeleteRaw(requestParameters: RealmRolesRoleNameCompositesDeleteRequest): 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 realmRolesRoleNameCompositesDelete.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameCompositesDelete.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesRoleNameCompositesDelete.');
}
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/{role-name}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Remove roles from the roles composite
*/
async realmRolesRoleNameCompositesDelete(requestParameters: RealmRolesRoleNameCompositesDeleteRequest): Promise<void> {
await this.realmRolesRoleNameCompositesDeleteRaw(requestParameters);
}
/**
* Get composites of the role
*/
async realmRolesRoleNameCompositesGetRaw(requestParameters: RealmRolesRoleNameCompositesGetRequest): 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 realmRolesRoleNameCompositesGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameCompositesGet.');
}
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/{role-name}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get composites of the role
*/
async realmRolesRoleNameCompositesGet(requestParameters: RealmRolesRoleNameCompositesGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesRoleNameCompositesGetRaw(requestParameters);
return await response.value();
}
/**
* Add a composite to the role
*/
async realmRolesRoleNameCompositesPostRaw(requestParameters: RealmRolesRoleNameCompositesPostRequest): 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 realmRolesRoleNameCompositesPost.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameCompositesPost.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesRoleNameCompositesPost.');
}
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/{role-name}/composites`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.roleRepresentation.map(RoleRepresentationToJSON),
});
return new runtime.VoidApiResponse(response);
}
/**
* Add a composite to the role
*/
async realmRolesRoleNameCompositesPost(requestParameters: RealmRolesRoleNameCompositesPostRequest): Promise<void> {
await this.realmRolesRoleNameCompositesPostRaw(requestParameters);
}
/**
* Get realm-level roles of the roles composite
*/
async realmRolesRoleNameCompositesRealmGetRaw(requestParameters: RealmRolesRoleNameCompositesRealmGetRequest): 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 realmRolesRoleNameCompositesRealmGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameCompositesRealmGet.');
}
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/{role-name}/composites/realm`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Get realm-level roles of the roles composite
*/
async realmRolesRoleNameCompositesRealmGet(requestParameters: RealmRolesRoleNameCompositesRealmGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesRoleNameCompositesRealmGetRaw(requestParameters);
return await response.value();
}
/**
* Delete a role by name
*/
async realmRolesRoleNameDeleteRaw(requestParameters: RealmRolesRoleNameDeleteRequest): 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 realmRolesRoleNameDelete.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameDelete.');
}
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/{role-name}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
});
return new runtime.VoidApiResponse(response);
}
/**
* Delete a role by name
*/
async realmRolesRoleNameDelete(requestParameters: RealmRolesRoleNameDeleteRequest): Promise<void> {
await this.realmRolesRoleNameDeleteRaw(requestParameters);
}
/**
* Get a role by name
*/
async realmRolesRoleNameGetRaw(requestParameters: RealmRolesRoleNameGetRequest): 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 realmRolesRoleNameGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameGet.');
}
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/{role-name}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => RoleRepresentationFromJSON(jsonValue));
}
/**
* Get a role by name
*/
async realmRolesRoleNameGet(requestParameters: RealmRolesRoleNameGetRequest): Promise<RoleRepresentation> {
const response = await this.realmRolesRoleNameGetRaw(requestParameters);
return await response.value();
}
/**
* Returns a stream of groups that have the specified role name
*/
async realmRolesRoleNameGroupsGetRaw(requestParameters: RealmRolesRoleNameGroupsGetRequest): 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 realmRolesRoleNameGroupsGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameGroupsGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.briefRepresentation !== undefined) {
queryParameters['briefRepresentation'] = requestParameters.briefRepresentation;
}
if (requestParameters.first !== undefined) {
queryParameters['first'] = requestParameters.first;
}
if (requestParameters.max !== undefined) {
queryParameters['max'] = requestParameters.max;
}
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/{role-name}/groups`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Returns a stream of groups that have the specified role name
*/
async realmRolesRoleNameGroupsGet(requestParameters: RealmRolesRoleNameGroupsGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesRoleNameGroupsGetRaw(requestParameters);
return await response.value();
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmRolesRoleNameManagementPermissionsGetRaw(requestParameters: RealmRolesRoleNameManagementPermissionsGetRequest): 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 realmRolesRoleNameManagementPermissionsGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameManagementPermissionsGet.');
}
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/{role-name}/management/permissions`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => ManagementPermissionReferenceFromJSON(jsonValue));
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmRolesRoleNameManagementPermissionsGet(requestParameters: RealmRolesRoleNameManagementPermissionsGetRequest): Promise<ManagementPermissionReference> {
const response = await this.realmRolesRoleNameManagementPermissionsGetRaw(requestParameters);
return await response.value();
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmRolesRoleNameManagementPermissionsPutRaw(requestParameters: RealmRolesRoleNameManagementPermissionsPutRequest): 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 realmRolesRoleNameManagementPermissionsPut.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameManagementPermissionsPut.');
}
if (requestParameters.managementPermissionReference === null || requestParameters.managementPermissionReference === undefined) {
throw new runtime.RequiredError('managementPermissionReference','Required parameter requestParameters.managementPermissionReference was null or undefined when calling realmRolesRoleNameManagementPermissionsPut.');
}
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/{role-name}/management/permissions`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: ManagementPermissionReferenceToJSON(requestParameters.managementPermissionReference),
});
return new runtime.JSONApiResponse(response, (jsonValue) => ManagementPermissionReferenceFromJSON(jsonValue));
}
/**
* Return object stating whether role Authorization permissions have been initialized or not and a reference
*/
async realmRolesRoleNameManagementPermissionsPut(requestParameters: RealmRolesRoleNameManagementPermissionsPutRequest): Promise<ManagementPermissionReference> {
const response = await this.realmRolesRoleNameManagementPermissionsPutRaw(requestParameters);
return await response.value();
}
/**
* Update a role by name
*/
async realmRolesRoleNamePutRaw(requestParameters: RealmRolesRoleNamePutRequest): 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 realmRolesRoleNamePut.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNamePut.');
}
if (requestParameters.roleRepresentation === null || requestParameters.roleRepresentation === undefined) {
throw new runtime.RequiredError('roleRepresentation','Required parameter requestParameters.roleRepresentation was null or undefined when calling realmRolesRoleNamePut.');
}
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/{role-name}`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: RoleRepresentationToJSON(requestParameters.roleRepresentation),
});
return new runtime.VoidApiResponse(response);
}
/**
* Update a role by name
*/
async realmRolesRoleNamePut(requestParameters: RealmRolesRoleNamePutRequest): Promise<void> {
await this.realmRolesRoleNamePutRaw(requestParameters);
}
/**
* Returns a stream of users that have the specified role name.
*/
async realmRolesRoleNameUsersGetRaw(requestParameters: RealmRolesRoleNameUsersGetRequest): 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 realmRolesRoleNameUsersGet.');
}
if (requestParameters.roleName === null || requestParameters.roleName === undefined) {
throw new runtime.RequiredError('roleName','Required parameter requestParameters.roleName was null or undefined when calling realmRolesRoleNameUsersGet.');
}
const queryParameters: runtime.HTTPQuery = {};
if (requestParameters.first !== undefined) {
queryParameters['first'] = requestParameters.first;
}
if (requestParameters.max !== undefined) {
queryParameters['max'] = requestParameters.max;
}
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/{role-name}/users`.replace(`{${"realm"}}`, encodeURIComponent(String(requestParameters.realm))).replace(`{${"role-name"}}`, encodeURIComponent(String(requestParameters.roleName))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse<any>(response);
}
/**
* Returns a stream of users that have the specified role name.
*/
async realmRolesRoleNameUsersGet(requestParameters: RealmRolesRoleNameUsersGetRequest): Promise<Array<{ [key: string]: object; }>> {
const response = await this.realmRolesRoleNameUsersGetRaw(requestParameters);
return await response.value();
}
}