Index (Atlassian OAuth 2 Provider

A C E F G H I L N O P R S T U V
All Classes and Interfaces|All Packages

A

AccessToken - Interface in com.atlassian.oauth2.provider.api.token.access
AUTHORIZATION_CODE - Enum constant in enum class com.atlassian.oauth2.provider.api.token.FlowType: The Authorization Code grant type is designed to acquire access tokens and refresh tokens.
authorizationEndpoint() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the authorizationEndpoint record component.

C

Client - Interface in com.atlassian.oauth2.provider.api.client
CLIENT_CREDENTIALS - Enum constant in enum class com.atlassian.oauth2.provider.api.token.FlowType: The Client Credentials grant type is suitable for machine-to-machine authentication.
ClientExpirationEvaluator - Interface in com.atlassian.oauth2.provider.api.client: Evaluates whether a client has breached its expiration limits.
ClientService - Interface in com.atlassian.oauth2.provider.api.client: Service for managing OAuth2 clients (from the provider's perspective).
CodeChallengeMethod - Enum Class in com.atlassian.oauth2.provider.api.pkce: Determines how the PKCE code verifier should be transformed and validated when exchanging an authorization code for access/refresh tokens.
com.atlassian.oauth2.provider.api.client - package com.atlassian.oauth2.provider.api.client
com.atlassian.oauth2.provider.api.client.internal - package com.atlassian.oauth2.provider.api.client.internal
com.atlassian.oauth2.provider.api.external - package com.atlassian.oauth2.provider.api.external
com.atlassian.oauth2.provider.api.pkce - package com.atlassian.oauth2.provider.api.pkce
com.atlassian.oauth2.provider.api.token - package com.atlassian.oauth2.provider.api.token
com.atlassian.oauth2.provider.api.token.access - package com.atlassian.oauth2.provider.api.token.access
com.atlassian.oauth2.provider.api.token.refresh - package com.atlassian.oauth2.provider.api.token.refresh
create(CreateClientEntity) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService
create(CreateClientEntity) - Method in interface com.atlassian.oauth2.provider.api.client.internal.InternalRotationClientService: Creates a Client
create(String, Scope, List<String>) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Deprecated.
CreateClientEntity - Record Class in com.atlassian.oauth2.provider.api.client
CreateClientEntity(String, Scope, List<String>, Set<GrantType>, Duration) - Constructor for record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Creates an instance of a CreateClientEntity record class.

E

equals(Object) - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Indicates whether some other object is "equal to" this one.
expiryDuration() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns the value of the expiryDuration record component.
expiryDuration() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns the value of the expiryDuration record component.

F

findClient(String) - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Find the client using the clientId
findClientByEntityId(String) - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Find the client using the client entity id
findClientLastAccessedDate(String) - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Finds the last accessed date for a client.
findLastAccessedDatesForClients(Collection<String>) - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Finds the last accessed date for each client by their client IDs.
findRedirectUrisByClientId(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Gets an existing redirect uri
FlowType - Enum Class in com.atlassian.oauth2.provider.api.token: Enum to represent the different types of OAuth2 flows supported by the provider
fromIdentifier(String) - Static method in enum class com.atlassian.oauth2.provider.api.token.FlowType
fromString(String) - Static method in enum class com.atlassian.oauth2.provider.api.pkce.CodeChallengeMethod

G

getAccessTokenId() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getAuthorizationCode() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getAuthorizationCode() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getAuthorizationDate() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getAuthorizationDate() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getByClientId(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Gets an existing Client
getById(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Gets an existing Client
getById(String) - Method in interface com.atlassian.oauth2.provider.api.client.internal.InternalRotationClientService: Gets an existing Client
getByRotatedClientId(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Gets an existing Client by rotated client id
getClientId() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getClientId() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getClientId() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getClientSecret() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getCreatedAt() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getCreatedAt() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getCreatedDate() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getDefaultClientCredentialExpiry() - Method in interface com.atlassian.oauth2.provider.api.client.ClientExpirationEvaluator: Gets the default expiry duration for client credentials in seconds.
getExpiryDuration() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getExpiryDurationInSeconds() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity
getExpiryDurationInSeconds() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity
getFlowIdentifier() - Method in enum class com.atlassian.oauth2.provider.api.token.FlowType
getGrantTypeUsedToCreate() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getId() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getId() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getId() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getLastAccessed() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getLastRotationDate() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getName() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getOAuth2AuthorizationServerMetadata() - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Gets the OAuth 2 server metadata: endpoints, response types supported, scopes supported etc
getRedirects() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getRefreshCount() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getRevocationEndpoint() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Deprecated.
getRotatedClientId() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getRotatedClientSecret() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getRotatedCreatedDate() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getScope() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getScope() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken: Deprecated.
getScope() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken: Deprecated.
getScopes() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getScopes() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
getSupportedGrantTypes() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getUserKey() - Method in interface com.atlassian.oauth2.provider.api.client.Client
getUserKey() - Method in interface com.atlassian.oauth2.provider.api.token.access.AccessToken
getUserKey() - Method in interface com.atlassian.oauth2.provider.api.token.refresh.RefreshToken
grantTypesSupported() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the grantTypesSupported record component.

H

hasExpireLimitBreached(Client) - Method in interface com.atlassian.oauth2.provider.api.client.ClientExpirationEvaluator: Checks if the client has breached its expiration limit.
hashCode() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns a hash code value for this object.
hashCode() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns a hash code value for this object.
hashCode() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns a hash code value for this object.
hasSoonToExpireLimitBreached(Client, Duration) - Method in interface com.atlassian.oauth2.provider.api.client.ClientExpirationEvaluator: Checks if the client has breached its soon-to-expire limit.

I

id() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns the value of the id record component.
InternalRotationClientService - Interface in com.atlassian.oauth2.provider.api.client.internal: An internal service for managing Oauth2 clients Used for background job in applinks to rotate client secrets without user context.
isClientCredentials(String) - Static method in enum class com.atlassian.oauth2.provider.api.token.FlowType: Deprecated, for removal: This API element is subject to removal in a future version.
will be removed in the 6.x major version.
isClientNameUnique(String, String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Checks if client name is unique
isClientSecretValid(String, String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Checks if the provided client secret is a match for the client secret stored against the client ID provided
isClientSecretValid(String, String, FlowType) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Checks if the provided client secret is a match for the client secret stored against the client ID provided.
isClientValid(String, String, FlowType) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Checks if the client is valid for the given flow type
isExpectedCodeChallengeGenerated(String, CodeChallengeMethod, String) - Method in interface com.atlassian.oauth2.provider.api.pkce.PkceService: Checks if the expected code challenge is produced by applying the given code challenge method to the given code verifier.
issuer() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the issuer record component.
isValidCode(String) - Method in interface com.atlassian.oauth2.provider.api.pkce.PkceService: Checks if the given string is a valid PKCE code challenge or PKCE code verifier.

L

list() - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Gets all Client
listClients() - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Gets all Clients
listCurrentUsersAccessTokens() - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Gets all the current users access tokens
listCurrentUsersRefreshTokens() - Method in interface com.atlassian.oauth2.provider.api.external.OAuth2ProviderService: Gets all the current users refresh tokens

N

name() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns the value of the name record component.
name() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns the value of the name record component.

O

OAuth2AuthorizationServerMetadata - Record Class in com.atlassian.oauth2.provider.api.external: Metadata object following spec: https://datatracker.ietf.org/doc/html/rfc8414
OAuth2AuthorizationServerMetadata(String, String, String, String, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>) - Constructor for record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Creates an instance of a OAuth2AuthorizationServerMetadata record class.
OAuth2ProviderService - Interface in com.atlassian.oauth2.provider.api.external

P

PKCE - Enum constant in enum class com.atlassian.oauth2.provider.api.token.FlowType: PKCE is an extension to the Authorization Code flow to prevent CSRF and authorization code injection attacks.
PkceService - Interface in com.atlassian.oauth2.provider.api.pkce: Methods used by the PKCE implementation https://datatracker.ietf.org/doc/html/rfc7636
PLAIN - Enum constant in enum class com.atlassian.oauth2.provider.api.pkce.CodeChallengeMethod
PUBLIC_FLOWS - Static variable in enum class com.atlassian.oauth2.provider.api.token.FlowType: Flows that do not require a client secret

R

redirects() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns the value of the redirects record component.
redirects() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns the value of the redirects record component.
REFRESH_TOKEN - Enum constant in enum class com.atlassian.oauth2.provider.api.token.FlowType: The Refresh Token grant type is used to obtain a new access token by using a refresh token.
RefreshToken - Interface in com.atlassian.oauth2.provider.api.token.refresh
removeById(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Deletes a Client
removeById(String) - Method in interface com.atlassian.oauth2.provider.api.client.internal.InternalRotationClientService: Deletes a Client
resetClientSecret(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService
responseModesSupported() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the responseModesSupported record component.
responseTypesSupported() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the responseTypesSupported record component.
revocationEndpoint() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the revocationEndpoint record component.
revocationEndpointAuthMethodsSupported() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the revocationEndpointAuthMethodsSupported record component.
revokeRotatedClientSecret(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Revokes the client secret and id for the rotated client, by removing the values.
revokeRotatedClientSecret(String) - Method in interface com.atlassian.oauth2.provider.api.client.internal.InternalRotationClientService: Revokes the client secret and id for the rotated client, by removing the values.
rotateClient(String) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Rotate the client id and secret for the given client id.
rotateClient(String) - Method in interface com.atlassian.oauth2.provider.api.client.internal.InternalRotationClientService: Rotate the client id and secret for the given client id.

S

S256 - Enum constant in enum class com.atlassian.oauth2.provider.api.pkce.CodeChallengeMethod
scope() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns the value of the scope record component.
scope() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns the value of the scope record component.
scopesSupported() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the scopesSupported record component.
supportedGrantTypes() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns the value of the supportedGrantTypes record component.
supportedGrantTypes() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns the value of the supportedGrantTypes record component.

T

tokenEndpoint() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the tokenEndpoint record component.
tokenEndpointAuthMethodsSupported() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns the value of the tokenEndpointAuthMethodsSupported record component.
toString() - Method in record class com.atlassian.oauth2.provider.api.client.CreateClientEntity: Returns a string representation of this record class.
toString() - Method in record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Returns a string representation of this record class.
toString() - Method in record class com.atlassian.oauth2.provider.api.external.OAuth2AuthorizationServerMetadata: Returns a string representation of this record class.
toString() - Method in enum class com.atlassian.oauth2.provider.api.pkce.CodeChallengeMethod

U

updateClient(UpdateClientEntity) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService
updateClient(String, String, String, List<String>) - Method in interface com.atlassian.oauth2.provider.api.client.ClientService: Deprecated.
UpdateClientEntity - Record Class in com.atlassian.oauth2.provider.api.client
UpdateClientEntity(String, String, String, List<String>, Set<GrantType>, Duration) - Constructor for record class com.atlassian.oauth2.provider.api.client.UpdateClientEntity: Creates an instance of a UpdateClientEntity record class.

V

valueOf(String) - Static method in enum class com.atlassian.oauth2.provider.api.pkce.CodeChallengeMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.atlassian.oauth2.provider.api.token.FlowType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.atlassian.oauth2.provider.api.pkce.CodeChallengeMethod: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.atlassian.oauth2.provider.api.token.FlowType: Returns an array containing the constants of this enum class, in the order they are declared.

A C E F G H I L N O P R S T U V
All Classes and Interfaces|All Packages