/* generated using openapi-typescript-codegen -- do not edit */ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ import type { PatchedSCIMGroup } from '../models/PatchedSCIMGroup'; import type { PatchedSCIMUserResponse } from '../models/PatchedSCIMUserResponse'; import type { SCIMGroup } from '../models/SCIMGroup'; import type { SCIMGroupListResponse } from '../models/SCIMGroupListResponse'; import type { SCIMUserCreateRequest } from '../models/SCIMUserCreateRequest'; import type { SCIMUserListResponse } from '../models/SCIMUserListResponse'; import type { SCIMUserResponse } from '../models/SCIMUserResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; export class ScimService { /** * List existing RBAC groups * List all existing RBAC groups for the specified platform. Only returns groups that have been pre-created in the RBAC system. * @returns SCIMGroupListResponse * @throws ApiError */ public static listGroups({ platformKey, format, }: { platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise> { return __request(OpenAPI, { method: 'GET', url: '/api/orgs/{platform_key}/scim/v2/Groups', path: { 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Manage existing user group * Add/remove users from an existing RBAC group for the specified platform. Does not create new groups. * @returns SCIMGroup * @throws ApiError */ public static manageGroup({ platformKey, requestBody, format, }: { platformKey: string, requestBody: SCIMGroup, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'POST', url: '/api/orgs/{platform_key}/scim/v2/Groups', path: { 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Get details of a specific RBAC group * Get details of a specific existing RBAC group by unique ID for the specified platform * @returns SCIMGroup * @throws ApiError */ public static retrieveGroup({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Update an existing RBAC group * Update an existing RBAC group's name, description, and members for the specified platform * @returns SCIMGroup * @throws ApiError */ public static updateGroup({ id, platformKey, requestBody, format, }: { id: string, platformKey: string, requestBody: SCIMGroup, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'PUT', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Partially update an existing RBAC group * Partially update an existing RBAC group's name, description, and members for the specified platform using PATCH method * @returns SCIMGroup * @throws ApiError */ public static partialUpdateGroup({ id, platformKey, format, requestBody, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', requestBody?: PatchedSCIMGroup, }): CancelablePromise { return __request(OpenAPI, { method: 'PATCH', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Delete an existing RBAC group * Delete an existing RBAC group from the system * @returns void * @throws ApiError */ public static deleteGroup({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'DELETE', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Get details of a specific RBAC group * Get details of a specific existing RBAC group by unique ID for the specified platform * @returns SCIMGroup * @throws ApiError */ public static retrieveGroup2({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Update an existing RBAC group * Update an existing RBAC group's name, description, and members for the specified platform * @returns SCIMGroup * @throws ApiError */ public static updateGroup2({ id, platformKey, requestBody, format, }: { id: string, platformKey: string, requestBody: SCIMGroup, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'PUT', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Partially update an existing RBAC group * Partially update an existing RBAC group's name, description, and members for the specified platform using PATCH method * @returns SCIMGroup * @throws ApiError */ public static partialUpdateGroup2({ id, platformKey, format, requestBody, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', requestBody?: PatchedSCIMGroup, }): CancelablePromise { return __request(OpenAPI, { method: 'PATCH', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Delete an existing RBAC group * Delete an existing RBAC group from the system * @returns void * @throws ApiError */ public static deleteGroup2({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'DELETE', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Add members to an existing RBAC group * Add members to an existing RBAC group using SCIM patch operations * @returns SCIMGroup * @throws ApiError */ public static addGroupMembers({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'POST', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/add_members', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Remove members from an existing RBAC group * Remove members from an existing RBAC group using SCIM patch operations * @returns SCIMGroup * @throws ApiError */ public static removeGroupMembers({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'POST', url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/remove_members', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * List users in the system * List users in the system for the specified platform * @returns SCIMUserListResponse * @throws ApiError */ public static listUsers({ platformKey, format, }: { platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise> { return __request(OpenAPI, { method: 'GET', url: '/api/orgs/{platform_key}/scim/v2/Users', path: { 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Create a new user in the system * Create a new user in the system for the specified platform * @returns SCIMUserResponse * @throws ApiError */ public static createUser({ platformKey, requestBody, format, }: { platformKey: string, requestBody: SCIMUserCreateRequest, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'POST', url: '/api/orgs/{platform_key}/scim/v2/Users', path: { 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Get details of a specific user * Get details of a specific user by ID for the specified platform * @returns SCIMUserResponse * @throws ApiError */ public static retrieveUser({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Update a user * Update a user for the specified platform * @returns SCIMUserResponse * @throws ApiError */ public static updateUser({ id, platformKey, requestBody, format, }: { id: string, platformKey: string, requestBody: SCIMUserCreateRequest, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'PUT', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Partially update an existing user * Partially update an existing user's information using PATCH method * @returns SCIMUserResponse * @throws ApiError */ public static partialUpdateUser({ id, platformKey, format, requestBody, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', requestBody?: PatchedSCIMUserResponse, }): CancelablePromise { return __request(OpenAPI, { method: 'PATCH', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Delete a user (not supported) * Delete a user for the specified platform (not supported) * @returns void * @throws ApiError */ public static deleteUser({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'DELETE', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Get details of a specific user * Get details of a specific user by ID for the specified platform * @returns SCIMUserResponse * @throws ApiError */ public static retrieveUser2({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } /** * Update a user * Update a user for the specified platform * @returns SCIMUserResponse * @throws ApiError */ public static updateUser2({ id, platformKey, requestBody, format, }: { id: string, platformKey: string, requestBody: SCIMUserCreateRequest, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'PUT', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Partially update an existing user * Partially update an existing user's information using PATCH method * @returns SCIMUserResponse * @throws ApiError */ public static partialUpdateUser2({ id, platformKey, format, requestBody, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', requestBody?: PatchedSCIMUserResponse, }): CancelablePromise { return __request(OpenAPI, { method: 'PATCH', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, body: requestBody, mediaType: 'application/json', }); } /** * Delete a user (not supported) * Delete a user for the specified platform (not supported) * @returns void * @throws ApiError */ public static deleteUser2({ id, platformKey, format, }: { id: string, platformKey: string, format?: 'json' | 'scim+json', }): CancelablePromise { return __request(OpenAPI, { method: 'DELETE', url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/', path: { 'id': id, 'platform_key': platformKey, }, query: { 'format': format, }, }); } }