com.okta.sdk.impl.resource.authorization.server

Class DefaultAuthorizationServer

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<AuthorizationServer>

com.okta.sdk.impl.resource.authorization.server.DefaultAuthorizationServer

All Implemented Interfaces:

AuthorizationServer, Deletable, ExtensibleResource, PropertyRetriever, Resource, Saveable<AuthorizationServer>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultAuthorizationServer
extends AbstractInstanceResource<AuthorizationServer>
implements AuthorizationServer

AuthorizationServer

Nested Class Summary

Nested classes/interfaces inherited from interface com.okta.sdk.resource.authorization.server.AuthorizationServer

AuthorizationServer.IssuerModeEnum, AuthorizationServer.StatusEnum

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultAuthorizationServer(InternalDataStore dataStore)
DefaultAuthorizationServer(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	activate() Success
OAuth2Claim	createOAuth2Claim(OAuth2Claim oAuth2Claim) Success
OAuth2Scope	createOAuth2Scope(OAuth2Scope oAuth2Scope) Success
AuthorizationServerPolicy	createPolicy(AuthorizationServerPolicy policy) Success
void	deactivate() Success
void	delete() Success
void	deleteOAuth2Claim(String claimId) Success
void	deleteOAuth2Scope(String scopeId) Success
void	deletePolicy(String policyId) Success
List<String>	getAudiences()
Date	getCreated()
AuthorizationServerCredentials	getCredentials()
String	getDescription()
String	getId()
String	getIssuer()
AuthorizationServer.IssuerModeEnum	getIssuerMode()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
OAuth2Claim	getOAuth2Claim(String claimId) Success
OAuth2Scope	getOAuth2Scope(String scopeId) Success
AuthorizationServerPolicy	getPolicy(String policyId) Success
Map<String,Property>	getPropertyDescriptors()
OAuth2RefreshToken	getRefreshTokenForClient(String clientId, String tokenId) Success
OAuth2RefreshToken	getRefreshTokenForClient(String clientId, String tokenId, String expand) Success
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
AuthorizationServer.StatusEnum	getStatus()
JsonWebKeyList	listKeys() Success
OAuth2ClaimList	listOAuth2Claims() Success
OAuth2ClientList	listOAuth2Clients() Success
OAuth2ScopeList	listOAuth2Scopes() Success
OAuth2ScopeList	listOAuth2Scopes(String q, String filter, String cursor) Success
AuthorizationServerPolicyList	listPolicies() Success
OAuth2RefreshTokenList	listRefreshTokensForClient(String clientId) Success
OAuth2RefreshTokenList	listRefreshTokensForClient(String clientId, String expand) Success
void	revokeRefreshTokenForClient(String clientId, String tokenId) Success
void	revokeRefreshTokensForClient(String clientId) Success
JsonWebKeyList	rotateKeys(JwkUse use) Success
AuthorizationServer	setAudiences(List<String> audiences)
AuthorizationServer	setCredentials(AuthorizationServerCredentials credentials)
AuthorizationServer	setDescription(String description)
AuthorizationServer	setIssuer(String issuer)
AuthorizationServer	setIssuerMode(AuthorizationServer.IssuerModeEnum issuerMode)
AuthorizationServer	setName(String name)
AuthorizationServer	setStatus(AuthorizationServer.StatusEnum status)
AuthorizationServer	update() Success
OAuth2Claim	updateOAuth2Claim(String claimId, OAuth2Claim oAuth2Claim) Success
OAuth2Scope	updateOAuth2Scope(String scopeId, OAuth2Scope oAuth2Scope) Success
AuthorizationServerPolicy	updatePolicy(String policyId, AuthorizationServerPolicy policy) Success

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultAuthorizationServer

public DefaultAuthorizationServer(InternalDataStore dataStore)

DefaultAuthorizationServer

public DefaultAuthorizationServer(InternalDataStore dataStore,
                                  Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<AuthorizationServer>

Returns:

The type of resource this class represents.

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface AuthorizationServer

getAudiences

public List<String> getAudiences()

Specified by:

getAudiences in interface AuthorizationServer

setAudiences

public AuthorizationServer setAudiences(List<String> audiences)

Specified by:

setAudiences in interface AuthorizationServer

getCreated

public Date getCreated()

Specified by:

getCreated in interface AuthorizationServer

getCredentials

public AuthorizationServerCredentials getCredentials()

Specified by:

getCredentials in interface AuthorizationServer

setCredentials

public AuthorizationServer setCredentials(AuthorizationServerCredentials credentials)

Specified by:

setCredentials in interface AuthorizationServer

getDescription

public String getDescription()

Specified by:

getDescription in interface AuthorizationServer

setDescription

public AuthorizationServer setDescription(String description)

Specified by:

setDescription in interface AuthorizationServer

getId

public String getId()

Specified by:

getId in interface AuthorizationServer

getIssuer

public String getIssuer()

Specified by:

getIssuer in interface AuthorizationServer

setIssuer

public AuthorizationServer setIssuer(String issuer)

Specified by:

setIssuer in interface AuthorizationServer

getIssuerMode

public AuthorizationServer.IssuerModeEnum getIssuerMode()

Specified by:

getIssuerMode in interface AuthorizationServer

setIssuerMode

public AuthorizationServer setIssuerMode(AuthorizationServer.IssuerModeEnum issuerMode)

Specified by:

setIssuerMode in interface AuthorizationServer

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface AuthorizationServer

getName

public String getName()

Specified by:

getName in interface AuthorizationServer

setName

public AuthorizationServer setName(String name)

Specified by:

setName in interface AuthorizationServer

getStatus

public AuthorizationServer.StatusEnum getStatus()

Specified by:

getStatus in interface AuthorizationServer

setStatus

public AuthorizationServer setStatus(AuthorizationServer.StatusEnum status)

Specified by:

setStatus in interface AuthorizationServer

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/lifecycle/activate")
public void activate()

Success

Specified by:

activate in interface AuthorizationServer

deleteOAuth2Claim

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/claims/{claimId}")
public void deleteOAuth2Claim(String claimId)

Success

Specified by:

deleteOAuth2Claim in interface AuthorizationServer

Parameters:

claimId - (required)

createOAuth2Scope

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/scopes")
public OAuth2Scope createOAuth2Scope(OAuth2Scope oAuth2Scope)

Success

Specified by:

createOAuth2Scope in interface AuthorizationServer

Parameters:

oAuth2Scope - (required)

Returns:

OAuth2Scope

getOAuth2Scope

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}")
public OAuth2Scope getOAuth2Scope(String scopeId)

Success

Specified by:

getOAuth2Scope in interface AuthorizationServer

Parameters:

scopeId - (required)

Returns:

OAuth2Scope

createPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies")
public AuthorizationServerPolicy createPolicy(AuthorizationServerPolicy policy)

Success

Specified by:

createPolicy in interface AuthorizationServer

Parameters:

policy - (required)

Returns:

AuthorizationServerPolicy

listPolicies

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies")
public AuthorizationServerPolicyList listPolicies()

Success

Specified by:

listPolicies in interface AuthorizationServer

Returns:

AuthorizationServerPolicyList

listOAuth2Claims

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/claims")
public OAuth2ClaimList listOAuth2Claims()

Success

Specified by:

listOAuth2Claims in interface AuthorizationServer

Returns:

OAuth2ClaimList

getOAuth2Claim

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/claims/{claimId}")
public OAuth2Claim getOAuth2Claim(String claimId)

Success

Specified by:

getOAuth2Claim in interface AuthorizationServer

Parameters:

claimId - (required)

Returns:

OAuth2Claim

listOAuth2Clients

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients")
public OAuth2ClientList listOAuth2Clients()

Success

Specified by:

listOAuth2Clients in interface AuthorizationServer

Returns:

OAuth2ClientList

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate")
public void deactivate()

Success

Specified by:

deactivate in interface AuthorizationServer

deleteOAuth2Scope

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}")
public void deleteOAuth2Scope(String scopeId)

Success

Specified by:

deleteOAuth2Scope in interface AuthorizationServer

Parameters:

scopeId - (required)

listKeys

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/credentials/keys")
public JsonWebKeyList listKeys()

Success

Specified by:

listKeys in interface AuthorizationServer

Returns:

JsonWebKeyList

listOAuth2Scopes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/scopes")
public OAuth2ScopeList listOAuth2Scopes(String q,
                                                                                                                                                                                                                                                String filter,
                                                                                                                                                                                                                                                String cursor)

Success

Specified by:

listOAuth2Scopes in interface AuthorizationServer

Parameters:

q - (optional)

filter - (optional)

cursor - (optional)

Returns:

OAuth2ScopeList

listOAuth2Scopes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/scopes")
public OAuth2ScopeList listOAuth2Scopes()

Success

Specified by:

listOAuth2Scopes in interface AuthorizationServer

Returns:

OAuth2ScopeList

revokeRefreshTokensForClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens")
public void revokeRefreshTokensForClient(String clientId)

Success

Specified by:

revokeRefreshTokensForClient in interface AuthorizationServer

Parameters:

clientId - (required)

rotateKeys

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate")
public JsonWebKeyList rotateKeys(JwkUse use)

Success

Specified by:

rotateKeys in interface AuthorizationServer

Parameters:

use - (required)

Returns:

JsonWebKeyList

listRefreshTokensForClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens")
public OAuth2RefreshTokenList listRefreshTokensForClient(String clientId,
                                                                                                                                                                                                                                                                                    String expand)

Success

Specified by:

listRefreshTokensForClient in interface AuthorizationServer

Parameters:

clientId - (required)

expand - (optional)

Returns:

OAuth2RefreshTokenList

listRefreshTokensForClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens")
public OAuth2RefreshTokenList listRefreshTokensForClient(String clientId)

Success

Specified by:

listRefreshTokensForClient in interface AuthorizationServer

Parameters:

clientId - (required)

Returns:

OAuth2RefreshTokenList

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}")
public void delete()

Success

Specified by:

delete in interface AuthorizationServer

Specified by:

delete in interface Deletable

Overrides:

delete in class AbstractInstanceResource<AuthorizationServer>

updateOAuth2Claim

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/claims/{claimId}")
public OAuth2Claim updateOAuth2Claim(String claimId,
                                                                                                                                                                                                                                                       OAuth2Claim oAuth2Claim)

Success

Specified by:

updateOAuth2Claim in interface AuthorizationServer

Parameters:

claimId - (required)

oAuth2Claim - (required)

Returns:

OAuth2Claim

getRefreshTokenForClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}")
public OAuth2RefreshToken getRefreshTokenForClient(String clientId,
                                                                                                                                                                                                                                                                                        String tokenId,
                                                                                                                                                                                                                                                                                        String expand)

Success

Specified by:

getRefreshTokenForClient in interface AuthorizationServer

Parameters:

clientId - (required)

tokenId - (required)

expand - (optional)

Returns:

OAuth2RefreshToken

getRefreshTokenForClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}")
public OAuth2RefreshToken getRefreshTokenForClient(String clientId,
                                                                                                                                                                                                                                                                                        String tokenId)

Success

Specified by:

getRefreshTokenForClient in interface AuthorizationServer

Parameters:

clientId - (required)

tokenId - (required)

Returns:

OAuth2RefreshToken

updatePolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
public AuthorizationServerPolicy updatePolicy(String policyId,
                                                                                                                                                                                                                                                                   AuthorizationServerPolicy policy)

Success

Specified by:

updatePolicy in interface AuthorizationServer

Parameters:

policyId - (required)

policy - (required)

Returns:

AuthorizationServerPolicy

revokeRefreshTokenForClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}")
public void revokeRefreshTokenForClient(String clientId,
                                                                                                                                                                                                                                                                                String tokenId)

Success

Specified by:

revokeRefreshTokenForClient in interface AuthorizationServer

Parameters:

clientId - (required)

tokenId - (required)

deletePolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
public void deletePolicy(String policyId)

Success

Specified by:

deletePolicy in interface AuthorizationServer

Parameters:

policyId - (required)

getPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
public AuthorizationServerPolicy getPolicy(String policyId)

Success

Specified by:

getPolicy in interface AuthorizationServer

Parameters:

policyId - (required)

Returns:

AuthorizationServerPolicy

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/authorizationServers/{authServerId}")
public AuthorizationServer update()

Success

Specified by:

update in interface AuthorizationServer

Returns:

AuthorizationServer

updateOAuth2Scope

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}")
public OAuth2Scope updateOAuth2Scope(String scopeId,
                                                                                                                                                                                                                                                       OAuth2Scope oAuth2Scope)

Success

Specified by:

updateOAuth2Scope in interface AuthorizationServer

Parameters:

scopeId - (required)

oAuth2Scope - (required)

Returns:

OAuth2Scope

createOAuth2Claim

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/claims")
public OAuth2Claim createOAuth2Claim(OAuth2Claim oAuth2Claim)

Success

Specified by:

createOAuth2Claim in interface AuthorizationServer

Parameters:

oAuth2Claim - (required)

Returns:

OAuth2Claim