com.okta.sdk.resource.authorization.server

Interface AuthorizationServer

All Superinterfaces:

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

All Known Implementing Classes:

DefaultAuthorizationServer

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface AuthorizationServer
extends ExtensibleResource, Deletable

AuthorizationServer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthorizationServer.IssuerModeEnum Enum issuerMode
static class	AuthorizationServer.StatusEnum Enum status

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

Map.Entry<K,V>

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
OAuth2RefreshToken	getRefreshTokenForClient(String clientId, String tokenId) Success
OAuth2RefreshToken	getRefreshTokenForClient(String clientId, String tokenId, String expand) Success
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 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

Method Detail

getLinks

Map<String,Object> getLinks()

getAudiences

List<String> getAudiences()

setAudiences

AuthorizationServer setAudiences(List<String> audiences)

getCreated

Date getCreated()

getCredentials

AuthorizationServerCredentials getCredentials()

setCredentials

AuthorizationServer setCredentials(AuthorizationServerCredentials credentials)

getDescription

String getDescription()

setDescription

AuthorizationServer setDescription(String description)

getId

String getId()

getIssuer

String getIssuer()

setIssuer

AuthorizationServer setIssuer(String issuer)

getIssuerMode

AuthorizationServer.IssuerModeEnum getIssuerMode()

setIssuerMode

AuthorizationServer setIssuerMode(AuthorizationServer.IssuerModeEnum issuerMode)

getLastUpdated

Date getLastUpdated()

getName

String getName()

setName

AuthorizationServer setName(String name)

getStatus

AuthorizationServer.StatusEnum getStatus()

setStatus

AuthorizationServer setStatus(AuthorizationServer.StatusEnum status)

activate

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

Success

deleteOAuth2Claim

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

Success

Parameters:

claimId - (required)

createOAuth2Scope

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

Success

Parameters:

oAuth2Scope - (required)

Returns:

OAuth2Scope

getOAuth2Scope

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

Success

Parameters:

scopeId - (required)

Returns:

OAuth2Scope

createPolicy

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

Success

Parameters:

policy - (required)

Returns:

AuthorizationServerPolicy

listPolicies

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

Success

Returns:

AuthorizationServerPolicyList

listOAuth2Claims

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

Success

Returns:

OAuth2ClaimList

getOAuth2Claim

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

Success

Parameters:

claimId - (required)

Returns:

OAuth2Claim

listOAuth2Clients

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

Success

Returns:

OAuth2ClientList

deactivate

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

Success

deleteOAuth2Scope

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

Success

Parameters:

scopeId - (required)

listKeys

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

Success

Returns:

JsonWebKeyList

listOAuth2Scopes

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

Success

Parameters:

q - (optional)

filter - (optional)

cursor - (optional)

Returns:

OAuth2ScopeList

listOAuth2Scopes

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

Success

Returns:

OAuth2ScopeList

revokeRefreshTokensForClient

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

Success

Parameters:

clientId - (required)

rotateKeys

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

Success

Parameters:

use - (required)

Returns:

JsonWebKeyList

listRefreshTokensForClient

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

Success

Parameters:

clientId - (required)

expand - (optional)

Returns:

OAuth2RefreshTokenList

listRefreshTokensForClient

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

Success

Parameters:

clientId - (required)

Returns:

OAuth2RefreshTokenList

delete

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

Success

Specified by:

delete in interface Deletable

updateOAuth2Claim

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

Success

Parameters:

claimId - (required)

oAuth2Claim - (required)

Returns:

OAuth2Claim

getRefreshTokenForClient

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

Success

Parameters:

clientId - (required)

tokenId - (required)

expand - (optional)

Returns:

OAuth2RefreshToken

getRefreshTokenForClient

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

Success

Parameters:

clientId - (required)

tokenId - (required)

Returns:

OAuth2RefreshToken

updatePolicy

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

Success

Parameters:

policyId - (required)

policy - (required)

Returns:

AuthorizationServerPolicy

revokeRefreshTokenForClient

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

Success

Parameters:

clientId - (required)

tokenId - (required)

deletePolicy

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

Success

Parameters:

policyId - (required)

getPolicy

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

Success

Parameters:

policyId - (required)

Returns:

AuthorizationServerPolicy

update

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

Success

Returns:

AuthorizationServer

updateOAuth2Scope

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

Success

Parameters:

scopeId - (required)

oAuth2Scope - (required)

Returns:

OAuth2Scope

createOAuth2Claim

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

Success

Parameters:

oAuth2Claim - (required)

Returns:

OAuth2Claim