| Package | Description |
|---|---|
| com.authlete.common.api |
The definition of Authlete API (
AuthleteApi) and the factory class (AuthleteApiFactory). |
| com.authlete.common.dto |
Requests to and responses from Authlete APIs and some data structures.
|
| Modifier and Type | Method and Description |
|---|---|
Service |
AuthleteApi.createService(Service service)
Create a service (= call Authlete's
/service/create API). |
Service |
AuthleteApi.createServie(Service service)
Deprecated.
Use correctly spelled
AuthleteApi.createService(Service). |
Service |
AuthleteApi.getService(long apiKey)
Get a service (= call Authlete's
/service/get/{apiKey} API). |
Service |
AuthleteApi.updateService(Service service)
Update a service (= call Authlete's
/service/update/{apiKey} API). |
| Modifier and Type | Method and Description |
|---|---|
Service |
AuthleteApi.createService(Service service)
Create a service (= call Authlete's
/service/create API). |
Service |
AuthleteApi.createServie(Service service)
Deprecated.
Use correctly spelled
AuthleteApi.createService(Service). |
Service |
AuthleteApi.updateService(Service service)
Update a service (= call Authlete's
/service/update/{apiKey} API). |
| Modifier and Type | Method and Description |
|---|---|
Service |
AuthorizationResponse.getService()
Get the information about the service.
|
Service[] |
ServiceListResponse.getServices()
Get the list of services.
|
Service |
Service.setAccessTokenDuration(long duration)
Set the duration of access tokens in seconds; the value of
expires_in in access token responses. |
Service |
Service.setAccessTokenSignAlg(JWSAlg alg)
Set the signature algorithm of access tokens.
|
Service |
Service.setAccessTokenSignatureKeyId(String keyId)
Set the key ID to identify a JWK used for signing access tokens.
|
Service |
Service.setAccessTokenType(String type)
Set the access token type; the value of
token_type in
access token responses. |
Service |
Service.setAllowableClockSkew(int seconds)
Set the allowable clock skew between the server and clients in seconds.
|
Service |
Service.setApiKey(long apiKey)
Set the API key.
|
Service |
Service.setApiSecret(String apiSecret)
Set the API secret.
|
Service |
Service.setAuthenticationCallbackApiKey(String apiKey)
Set the API key to access the authentication callback endpoint.
|
Service |
Service.setAuthenticationCallbackApiSecret(String apiSecret)
Set the API secret to access the authentication callback endpoint.
|
Service |
Service.setAuthenticationCallbackEndpoint(URI endpoint)
Set the URI of the authentication callback endpoint.
|
Service |
Service.setAuthorizationEndpoint(URI endpoint)
Set the URI of the authorization endpoint.
|
Service |
Service.setAuthorizationResponseDuration(long duration)
Set the duration of authorization response JWTs.
|
Service |
Service.setAuthorizationSignatureKeyId(String keyId)
Set the key ID to identify a JWK used for signing authorization responses
using an asymmetric key.
|
Service |
Service.setBackchannelAuthenticationEndpoint(URI endpoint)
Set the URI of the backchannel authentication endpoint.
|
Service |
Service.setBackchannelAuthReqIdDuration(int duration)
Set the duration of backchannel authentication request IDs issued from
the backchannel authentication endpoint in seconds.
|
Service |
Service.setBackchannelBindingMessageRequiredInFapi(boolean required)
Set the boolean flag which indicates whether the
binding_message
request parameter is always required whenever a backchannel authentication
request is judged as a request for Financial-grade API. |
Service |
Service.setBackchannelPollingInterval(int interval)
Set the minimum interval between polling requests to the token endpoint
from client applications in seconds.
|
Service |
Service.setBackchannelUserCodeParameterSupported(boolean supported)
Set the boolean flag which indicates whether the
"user_code"
request parameter is supported at the backchannel authentication
endpoint. |
Service |
Service.setClientIdAliasEnabled(boolean enabled)
Enable/disable the 'Client ID Alias' feature.
|
Service |
Service.setClientsPerDeveloper(int count)
Set the number of client applications that one developer can create.
|
Service |
Service.setCreatedAt(long createdAt)
Set the time at which this service was created.
|
Service |
Service.setDescription(String description)
Set the description.
|
Service |
Service.setDeveloperAuthenticationCallbackApiKey(String apiKey)
Set the API key to access the developer authentication callback endpoint.
|
Service |
Service.setDeveloperAuthenticationCallbackApiSecret(String apiSecret)
Set the API secret to access the developer authentication callback endpoint.
|
Service |
Service.setDeveloperAuthenticationCallbackEndpoint(URI endpoint)
Set the URI of the developer authentication callback endpoint.
|
Service |
Service.setDeveloperSnsCredentials(SnsCredentials[] snsCredentials)
Set the list of SNS credentials that Authlete uses to support social login
at the developer console.
|
Service |
Service.setDeviceAuthorizationEndpoint(URI endpoint)
Set the URI of the device authorization endpoint.
|
Service |
Service.setDeviceFlowCodeDuration(int duration)
Set the duration of device verification codes and end-user verification
codes issued from the device authorization endpoint in seconds.
|
Service |
Service.setDeviceFlowPollingInterval(int interval)
Set the minimum interval between polling requests to the token endpoint
from client applications in seconds in device flow.
|
Service |
Service.setDeviceVerificationUri(URI uri)
Set the verification URI for the device flow.
|
Service |
Service.setDeviceVerificationUriComplete(URI uri)
Set the verification URI for the device flow with a placeholder for a
user code.
|
Service |
Service.setDirectAuthorizationEndpointEnabled(boolean enabled)
Set the flag which indicates whether the direct authorization endpoint
is enabled or not.
|
Service |
Service.setDirectIntrospectionEndpointEnabled(boolean enabled)
Set the flag which indicates whether the direct introspection endpoint
is enabled or not.
|
Service |
Service.setDirectJwksEndpointEnabled(boolean enabled)
Set the flag which indicates whether the direct jwks endpoint
is enabled or not.
|
Service |
Service.setDirectRevocationEndpointEnabled(boolean enabled)
Set the flag which indicates whether the direct revocation endpoint
is enabled or not.
|
Service |
Service.setDirectTokenEndpointEnabled(boolean enabled)
Set the flag which indicates whether the direct token endpoint
is enabled or not.
|
Service |
Service.setDirectUserInfoEndpointEnabled(boolean enabled)
Set the flag which indicates whether the direct userinfo endpoint
is enabled or not.
|
Service |
Service.setDynamicRegistrationSupported(boolean enabled)
Set the flag which indicates whether dynamic client registration is supported.
|
Service |
Service.setErrorDescriptionOmitted(boolean omitted)
Omit or embed the
error_description response parameter in
error responses. |
Service |
Service.setErrorUriOmitted(boolean omitted)
Omit or embed the
error_uri response parameter in error
responses. |
Service |
Service.setIdTokenDuration(long duration)
Set the duration of ID tokens in seconds.
|
Service |
Service.setIdTokenSignatureKeyId(String keyId)
Set the key ID to identify a JWK used for ID token signature using
an asymmetric key.
|
Service |
Service.setIntrospectionEndpoint(URI endpoint)
Set the URI of the introspection endpoint.
|
Service |
Service.setIssuer(URI issuer)
Set the issuer identifier of this OpenID provider.
|
Service |
Service.setJwks(String jwks)
Set the JSON Web Key Set of the service.
|
Service |
Service.setJwksUri(URI uri)
Set the URI of the service's JSON Web Key Set.
|
Service |
Service.setMetadata(Pair[] metadata)
Set metadata.
|
Service |
Service.setModifiedAt(long modifiedAt)
Set the time at which this service was last modified.
|
Service |
Service.setMtlsEndpointAliases(NamedUri[] aliases)
Set the MTLS endpoint aliases.
|
Service |
Service.setMutualTlsValidatePkiCertChain(boolean mutualTlsValidatePkiCertChain)
Set whether this service validates certificate chains during PKI-based
client mutual TLS authentication.
|
Service |
Service.setNumber(int number)
Set the service number.
|
Service |
Service.setPkceRequired(boolean required)
Set the flag which indicates whether the use of Proof Key for Code
Exchange (PKCE) is always required for authorization requests
by Authorization Code Flow.
|
Service |
Service.setPkceS256Required(boolean required)
Set the flag which indicates whether
S256 is always required
as the code challenge method whenever PKCE (RFC 7636) is used. |
Service |
Service.setPolicyUri(URI uri)
Set the URI that this OpenID Provider provides to the person
registering the client to read about the OP's requirements on
how the Relying Party can use the data provided by the OP.
|
Service |
Service.setPushedAuthReqDuration(long duration)
Set the duration of pushed authorization requests.
|
Service |
Service.setRefreshTokenDuration(long duration)
Set the duration of refresh tokens in seconds.
|
Service |
Service.setRefreshTokenKept(boolean kept)
Set the flag which indicates whether a refresh token remains valid
or gets renewed after its use.
|
Service |
Service.setRegistrationEndpoint(URI endpoint)
Set the URI of the registration endpoint.
|
Service |
Service.setRegistrationManagementEndpoint(URI endpoint)
Set the URI of the registration management endpoint.
|
Service |
Service.setRequestObjectEndpoint(URI endpoint)
Set the URI of the request object endpoint.
|
Service |
Service.setRevocationEndpoint(URI endpoint)
Set the URI of the token revocation endpoint.
|
Service |
Service.setServiceDocumentation(URI uri)
Set the URI of a page containing human-readable information
that developers might want or need to know when using this
OpenID Provider.
|
Service |
Service.setServiceName(String serviceName)
Set the service name.
|
Service |
Service.setServiceOwnerNumber(int serviceOwnerNumber)
Set the service owner number
|
Service |
Service.setSingleAccessTokenPerSubject(boolean single)
Set the flag which indicates whether the number of access tokens
per subject (and per client) is at most one or can be more.
|
Service |
Service.setSnsCredentials(SnsCredentials[] snsCredentials)
Set the list of SNS credentials that Authlete uses to support social login.
|
Service |
Service.setSupportedAcrs(String[] acrs)
Set the supported ACRs (authentication context class references).
|
Service |
Service.setSupportedBackchannelTokenDeliveryModes(DeliveryMode[] modes)
Get the supported backchannel token delivery modes.
|
Service |
Service.setSupportedClaimLocales(String[] supportedClaimLocales)
Set the supported claim locales.
|
Service |
Service.setSupportedClaims(String[] supportedClaims)
Set the supported claims.
|
Service |
Service.setSupportedClaimTypes(ClaimType[] claimTypes)
Set the supported claim types.
|
Service |
Service.setSupportedDeveloperSnses(Sns[] supportedSnses)
Set the list of supported SNSes for social login at the developer console.
|
Service |
Service.setSupportedDisplays(Display[] displays)
Set the supported values of
display parameter passed to
the authorization endpoint. |
Service |
Service.setSupportedGrantTypes(GrantType[] grantTypes)
Set the supported grant types.
|
Service |
Service.setSupportedIntrospectionAuthMethods(ClientAuthMethod[] methods)
Set client authentication methods supported at the introspection endpoint.
|
Service |
Service.setSupportedResponseTypes(ResponseType[] responseTypes)
Set the supported response types.
|
Service |
Service.setSupportedRevocationAuthMethods(ClientAuthMethod[] methods)
Set client authentication methods supported at the revocation endpoint.
|
Service |
Service.setSupportedScopes(Scope[] supportedScopes)
Set the supported scopes.
|
Service |
Service.setSupportedServiceProfiles(Iterable<ServiceProfile> profiles)
Set the supported service profiles.
|
Service |
Service.setSupportedServiceProfiles(ServiceProfile[] profiles)
Set the supported service profiles.
|
Service |
Service.setSupportedSnses(Sns[] supportedSnses)
Set the list of supported SNSes for social login at the authorization
endpoint.
|
Service |
Service.setSupportedTokenAuthMethods(ClientAuthMethod[] methods)
Set the number of client authentication methods at the token endpoint.
|
Service |
Service.setSupportedUiLocales(String[] supportedUiLocales)
Set the supported UI locales.
|
Service |
Service.setTlsClientCertificateBoundAccessTokens(boolean enabled)
Enable or disable support for TLS client certificate bound access tokens.
|
Service |
Service.setTokenEndpoint(URI endpoint)
Set the URI of the token endpoint.
|
Service |
Service.setTosUri(URI uri)
Set the URI that the OpenID Provider provides to the person
registering the client to read about the OP's terms of service.
|
Service |
Service.setTrustedRootCertificates(String[] trustedRootCertificates)
Get the list of root certificates trusted by this service for PKI-based
client mutual TLS authentication.
|
Service |
Service.setUserCodeCharset(UserCodeCharset charset)
Set the character set for end-user verification codes
(
user_code) for Device Flow. |
Service |
Service.setUserCodeLength(int length)
Set the length of end-user verification codes (
user_code) for
Device Flow. |
Service |
Service.setUserInfoEndpoint(URI endpoint)
Set the URI of the user info endpoint.
|
Service |
Service.setUserInfoSignatureKeyId(String keyId)
Set the key ID to identify a JWK used for user info signature using
an asymmetric key.
|
| Modifier and Type | Method and Description |
|---|---|
void |
AuthorizationResponse.setService(Service service)
Set the information about the service.
|
ServiceListResponse |
ServiceListResponse.setServices(Service[] services)
Set the list of services that match the query conditions.
|
Copyright © 2019. All rights reserved.