Package com.okta.sdk.resource.api

Class AuthorizationServerScopesApi

java.lang.Object

com.okta.sdk.resource.api.AuthorizationServerScopesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
           comments="Generator version: 7.15.0")
public class AuthorizationServerScopesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AuthorizationServerScopesApi()
AuthorizationServerScopesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
OAuth2Scope	createOAuth2Scope(String authServerId, OAuth2Scope oAuth2Scope)	Create a custom token scope Creates a custom token scope
OAuth2Scope	createOAuth2Scope(String authServerId, OAuth2Scope oAuth2Scope, Map<String,String> additionalHeaders)	Create a custom token scope Creates a custom token scope
void	deleteOAuth2Scope(String authServerId, String scopeId)	Delete a custom token scope Deletes a custom token scope
void	deleteOAuth2Scope(String authServerId, String scopeId, Map<String,String> additionalHeaders)	Delete a custom token scope Deletes a custom token scope
ApiClient	getApiClient()
OAuth2Scope	getOAuth2Scope(String authServerId, String scopeId)	Retrieve a custom token scope Retrieves a custom token scope
OAuth2Scope	getOAuth2Scope(String authServerId, String scopeId, Map<String,String> additionalHeaders)	Retrieve a custom token scope Retrieves a custom token scope
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<OAuth2Scope>	listOAuth2Scopes(String authServerId, String q, String filter, String after, Integer limit)	List all custom token scopes Lists all custom token scopes
List<OAuth2Scope>	listOAuth2Scopes(String authServerId, String q, String filter, String after, Integer limit, Map<String,String> additionalHeaders)	List all custom token scopes Lists all custom token scopes
Iterable<OAuth2Scope>	listOAuth2ScopesPaged(String authServerId, String q, String filter, String after, Integer limit)	List all custom token scopes (Paginated) Lists all custom token scopes This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<OAuth2Scope>	listOAuth2ScopesPaged(String authServerId, String q, String filter, String after, Integer limit, Map<String,String> additionalHeaders)	List all custom token scopes (Paginated with additional headers) Lists all custom token scopes This method returns a lazy, paginated iterable that automatically handles pagination.
OAuth2Scope	replaceOAuth2Scope(String authServerId, String scopeId, OAuth2Scope oAuth2Scope)	Replace a custom token scope Replaces a custom token scope
OAuth2Scope	replaceOAuth2Scope(String authServerId, String scopeId, OAuth2Scope oAuth2Scope, Map<String,String> additionalHeaders)	Replace a custom token scope Replaces a custom token scope
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationServerScopesApi

public AuthorizationServerScopesApi()

AuthorizationServerScopesApi

public AuthorizationServerScopesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createOAuth2Scope

public OAuth2Scope createOAuth2Scope(String authServerId,
 OAuth2Scope oAuth2Scope)
                              throws ApiException

Create a custom token scope Creates a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

oAuth2Scope - (required)

Returns:

OAuth2Scope

Throws:

ApiException - if fails to make API call

createOAuth2Scope

public OAuth2Scope createOAuth2Scope(String authServerId,
 OAuth2Scope oAuth2Scope,
 Map<String,String> additionalHeaders)
                              throws ApiException

Create a custom token scope Creates a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

oAuth2Scope - (required)

additionalHeaders - additionalHeaders for this call

Returns:

OAuth2Scope

Throws:

ApiException - if fails to make API call

deleteOAuth2Scope

public void deleteOAuth2Scope(String authServerId,
 String scopeId)
                       throws ApiException

Delete a custom token scope Deletes a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

scopeId - `id` of Scope (required)

Throws:

ApiException - if fails to make API call

deleteOAuth2Scope

public void deleteOAuth2Scope(String authServerId,
 String scopeId,
 Map<String,String> additionalHeaders)
                       throws ApiException

Delete a custom token scope Deletes a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

scopeId - `id` of Scope (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getOAuth2Scope

public OAuth2Scope getOAuth2Scope(String authServerId,
 String scopeId)
                           throws ApiException

Retrieve a custom token scope Retrieves a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

scopeId - `id` of Scope (required)

Returns:

OAuth2Scope

Throws:

ApiException - if fails to make API call

getOAuth2Scope

public OAuth2Scope getOAuth2Scope(String authServerId,
 String scopeId,
 Map<String,String> additionalHeaders)
                           throws ApiException

Retrieve a custom token scope Retrieves a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

scopeId - `id` of Scope (required)

additionalHeaders - additionalHeaders for this call

Returns:

OAuth2Scope

Throws:

ApiException - if fails to make API call

listOAuth2Scopes

public List<OAuth2Scope> listOAuth2Scopes(String authServerId,
 String q,
 String filter,
 String after,
 Integer limit)
                                   throws ApiException

List all custom token scopes Lists all custom token scopes

Parameters:

authServerId - `id` of the Authorization Server (required)

q - Searches the `name` of Custom Token Scopes for matching values (optional)

filter - Filter expression for Custom Token Scopes (optional)

after - Specifies the pagination cursor for the next page of scopes. Treat the after cursor as an opaque value and obtain it through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

Returns:

List<OAuth2Scope>

Throws:

ApiException - if fails to make API call

listOAuth2Scopes

public List<OAuth2Scope> listOAuth2Scopes(String authServerId,
 String q,
 String filter,
 String after,
 Integer limit,
 Map<String,String> additionalHeaders)
                                   throws ApiException

List all custom token scopes Lists all custom token scopes

Parameters:

authServerId - `id` of the Authorization Server (required)

q - Searches the `name` of Custom Token Scopes for matching values (optional)

filter - Filter expression for Custom Token Scopes (optional)

after - Specifies the pagination cursor for the next page of scopes. Treat the after cursor as an opaque value and obtain it through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<OAuth2Scope>

Throws:

ApiException - if fails to make API call

listOAuth2ScopesPaged

public Iterable<OAuth2Scope> listOAuth2ScopesPaged(String authServerId,
 String q,
 String filter,
 String after,
 Integer limit)

List all custom token scopes (Paginated) Lists all custom token scopes This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

authServerId - `id` of the Authorization Server (required)

q - Searches the `name` of Custom Token Scopes for matching values (optional)

filter - Filter expression for Custom Token Scopes (optional)

after - Specifies the pagination cursor for the next page of scopes. Treat the after cursor as an opaque value and obtain it through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

Returns:

Iterable<OAuth2Scope> lazy iterable over all pages

listOAuth2ScopesPaged

public Iterable<OAuth2Scope> listOAuth2ScopesPaged(String authServerId,
 String q,
 String filter,
 String after,
 Integer limit,
 Map<String,String> additionalHeaders)

List all custom token scopes (Paginated with additional headers) Lists all custom token scopes This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

authServerId - `id` of the Authorization Server (required)

q - Searches the `name` of Custom Token Scopes for matching values (optional)

filter - Filter expression for Custom Token Scopes (optional)

after - Specifies the pagination cursor for the next page of scopes. Treat the after cursor as an opaque value and obtain it through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

additionalHeaders - additional headers for this call

Returns:

Iterable<OAuth2Scope> lazy iterable over all pages

replaceOAuth2Scope

public OAuth2Scope replaceOAuth2Scope(String authServerId,
 String scopeId,
 OAuth2Scope oAuth2Scope)
                               throws ApiException

Replace a custom token scope Replaces a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

scopeId - `id` of Scope (required)

oAuth2Scope - (required)

Returns:

OAuth2Scope

Throws:

ApiException - if fails to make API call

replaceOAuth2Scope

public OAuth2Scope replaceOAuth2Scope(String authServerId,
 String scopeId,
 OAuth2Scope oAuth2Scope,
 Map<String,String> additionalHeaders)
                               throws ApiException

Replace a custom token scope Replaces a custom token scope

Parameters:

authServerId - `id` of the Authorization Server (required)

scopeId - `id` of Scope (required)

oAuth2Scope - (required)

additionalHeaders - additionalHeaders for this call

Returns:

OAuth2Scope

Throws:

ApiException - if fails to make API call

getObjectMapper

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