Package com.okta.sdk.resource.api

Class RoleECustomApi

java.lang.Object

com.okta.sdk.resource.api.RoleECustomApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class RoleECustomApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RoleECustomApi()
RoleECustomApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
IamRole	createRole(CreateIamRoleRequest instance)	Create a Custom Role Creates a Custom Role
IamRole	createRole(CreateIamRoleRequest instance, Map<String,String> additionalHeaders)	Create a Custom Role Creates a Custom Role
void	deleteRole(String roleIdOrLabel)	Delete a Custom Role Deletes a Custom Role by `roleIdOrLabel`
void	deleteRole(String roleIdOrLabel, Map<String,String> additionalHeaders)	Delete a Custom Role Deletes a Custom Role by `roleIdOrLabel`
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
IamRole	getRole(String roleIdOrLabel)	Retrieve a Role Retrieves a role by `roleIdOrLabel`
IamRole	getRole(String roleIdOrLabel, Map<String,String> additionalHeaders)	Retrieve a Role Retrieves a role by `roleIdOrLabel`
IamRoles	listRoles(String after)	List all Custom Roles Lists all Custom Roles with pagination support
IamRoles	listRoles(String after, Map<String,String> additionalHeaders)	List all Custom Roles Lists all Custom Roles with pagination support
IamRole	replaceRole(String roleIdOrLabel, UpdateIamRoleRequest instance)	Replace a Custom Role Replaces the label and description for a Custom Role by `roleIdOrLabel`
IamRole	replaceRole(String roleIdOrLabel, UpdateIamRoleRequest instance, Map<String,String> additionalHeaders)	Replace a Custom Role Replaces the label and description for a Custom Role by `roleIdOrLabel`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RoleECustomApi

public RoleECustomApi()

RoleECustomApi

public RoleECustomApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createRole

public IamRole createRole(CreateIamRoleRequest instance)
                   throws ApiException

Create a Custom Role Creates a Custom Role

Parameters:

instance - (required)

Returns:

IamRole

Throws:

ApiException - if fails to make API call

createRole

public IamRole createRole(CreateIamRoleRequest instance,
 Map<String,String> additionalHeaders)
                   throws ApiException

Create a Custom Role Creates a Custom Role

Parameters:

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

IamRole

Throws:

ApiException - if fails to make API call

deleteRole

public void deleteRole(String roleIdOrLabel)
                throws ApiException

Delete a Custom Role Deletes a Custom Role by `roleIdOrLabel`

Parameters:

roleIdOrLabel - `id` or `label` of the Role (required)

Throws:

ApiException - if fails to make API call

deleteRole

public void deleteRole(String roleIdOrLabel,
 Map<String,String> additionalHeaders)
                throws ApiException

Delete a Custom Role Deletes a Custom Role by `roleIdOrLabel`

Parameters:

roleIdOrLabel - `id` or `label` of the Role (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getRole

public IamRole getRole(String roleIdOrLabel)
                throws ApiException

Retrieve a Role Retrieves a role by `roleIdOrLabel`

Parameters:

roleIdOrLabel - `id` or `label` of the Role (required)

Returns:

IamRole

Throws:

ApiException - if fails to make API call

getRole

public IamRole getRole(String roleIdOrLabel,
 Map<String,String> additionalHeaders)
                throws ApiException

Retrieve a Role Retrieves a role by `roleIdOrLabel`

Parameters:

roleIdOrLabel - `id` or `label` of the Role (required)

additionalHeaders - additionalHeaders for this call

Returns:

IamRole

Throws:

ApiException - if fails to make API call

listRoles

public IamRoles listRoles(String after)
                   throws ApiException

List all Custom Roles Lists all Custom Roles with pagination support

Parameters:

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). (optional)

Returns:

IamRoles

Throws:

ApiException - if fails to make API call

listRoles

public IamRoles listRoles(String after,
 Map<String,String> additionalHeaders)
                   throws ApiException

List all Custom Roles Lists all Custom Roles with pagination support

Parameters:

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). (optional)

additionalHeaders - additionalHeaders for this call

Returns:

IamRoles

Throws:

ApiException - if fails to make API call

replaceRole

public IamRole replaceRole(String roleIdOrLabel,
 UpdateIamRoleRequest instance)
                    throws ApiException

Replace a Custom Role Replaces the label and description for a Custom Role by `roleIdOrLabel`

Parameters:

roleIdOrLabel - `id` or `label` of the Role (required)

instance - (required)

Returns:

IamRole

Throws:

ApiException - if fails to make API call

replaceRole

public IamRole replaceRole(String roleIdOrLabel,
 UpdateIamRoleRequest instance,
 Map<String,String> additionalHeaders)
                    throws ApiException

Replace a Custom Role Replaces the label and description for a Custom Role by `roleIdOrLabel`

Parameters:

roleIdOrLabel - `id` or `label` of the Role (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

IamRole

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()