/*! * Copyright (c) 2017-present, Okta, Inc. and/or its affiliates. All rights reserved. * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.") * * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * * See the License for the specific language governing permissions and limitations under the License. */ import { BaseAPIRequestFactory } from './baseapi'; import { Configuration } from '../configuration'; import { RequestContext, ResponseContext } from '../http/http'; import { CreateIamRoleRequest } from '../models/CreateIamRoleRequest'; import { CreateUpdateIamRolePermissionRequest } from '../models/CreateUpdateIamRolePermissionRequest'; import { IamRole } from '../models/IamRole'; import { IamRoles } from '../models/IamRoles'; import { Permission } from '../models/Permission'; import { Permissions } from '../models/Permissions'; import { UpdateIamRoleRequest } from '../models/UpdateIamRoleRequest'; /** * no description */ export declare class CustomRoleApiRequestFactory extends BaseAPIRequestFactory { /** * Creates a custom role * Create a custom role * @param instance */ createRole(instance: CreateIamRoleRequest, _options?: Configuration): Promise; /** * Creates a permission (specified by `permissionType`) for a custom role * Create a custom role permission * @param roleIdOrLabel `id` or `label` of the role * @param permissionType An Okta [permission](https://developer.okta.com/docs/api/openapi/okta-management/guides/permissions) * @param instance */ createRolePermission(roleIdOrLabel: string, permissionType: string, instance?: CreateUpdateIamRolePermissionRequest, _options?: Configuration): Promise; /** * Deletes a custom role by `roleIdOrLabel` * Delete a custom role * @param roleIdOrLabel `id` or `label` of the role */ deleteRole(roleIdOrLabel: string, _options?: Configuration): Promise; /** * Deletes a permission (identified by `permissionType`) from a custom role * Delete a custom role permission * @param roleIdOrLabel `id` or `label` of the role * @param permissionType An Okta [permission](https://developer.okta.com/docs/api/openapi/okta-management/guides/permissions) */ deleteRolePermission(roleIdOrLabel: string, permissionType: string, _options?: Configuration): Promise; /** * Retrieves a role by `roleIdOrLabel` * Retrieve a role * @param roleIdOrLabel `id` or `label` of the role */ getRole(roleIdOrLabel: string, _options?: Configuration): Promise; /** * Retrieves a permission (identified by `permissionType`) for a custom role * Retrieve a custom role permission * @param roleIdOrLabel `id` or `label` of the role * @param permissionType An Okta [permission](https://developer.okta.com/docs/api/openapi/okta-management/guides/permissions) */ getRolePermission(roleIdOrLabel: string, permissionType: string, _options?: Configuration): Promise; /** * Lists all permissions for a custom role by `roleIdOrLabel` * List all custom role permissions * @param roleIdOrLabel `id` or `label` of the role */ listRolePermissions(roleIdOrLabel: string, _options?: Configuration): Promise; /** * Lists all custom roles with pagination support * List all custom roles * @param after The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). */ listRoles(after?: string, _options?: Configuration): Promise; /** * Replaces the label and description for a custom role by `roleIdOrLabel` * Replace a custom role * @param roleIdOrLabel `id` or `label` of the role * @param instance */ replaceRole(roleIdOrLabel: string, instance: UpdateIamRoleRequest, _options?: Configuration): Promise; /** * Replaces a permission (specified by `permissionType`) for a custom role * Replace a custom role permission * @param roleIdOrLabel `id` or `label` of the role * @param permissionType An Okta [permission](https://developer.okta.com/docs/api/openapi/okta-management/guides/permissions) * @param instance */ replaceRolePermission(roleIdOrLabel: string, permissionType: string, instance?: CreateUpdateIamRolePermissionRequest, _options?: Configuration): Promise; } export declare class CustomRoleApiResponseProcessor { /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createRole * @throws ApiException if the response code was not in [200, 299] */ createRole(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createRolePermission * @throws ApiException if the response code was not in [200, 299] */ createRolePermission(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteRole * @throws ApiException if the response code was not in [200, 299] */ deleteRole(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteRolePermission * @throws ApiException if the response code was not in [200, 299] */ deleteRolePermission(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getRole * @throws ApiException if the response code was not in [200, 299] */ getRole(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getRolePermission * @throws ApiException if the response code was not in [200, 299] */ getRolePermission(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listRolePermissions * @throws ApiException if the response code was not in [200, 299] */ listRolePermissions(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listRoles * @throws ApiException if the response code was not in [200, 299] */ listRoles(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to replaceRole * @throws ApiException if the response code was not in [200, 299] */ replaceRole(response: ResponseContext): Promise; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to replaceRolePermission * @throws ApiException if the response code was not in [200, 299] */ replaceRolePermission(response: ResponseContext): Promise; }