Package | Description |
---|---|
com.nimbusds.oauth2.sdk |
Classes for representing, serialising and parsing OAuth 2.0 client requests
and authorisation server responses.
|
com.nimbusds.oauth2.sdk.as |
OAuth 2.0 Authorisation Server (AS) classes.
|
com.nimbusds.oauth2.sdk.client |
OAuth 2.0 dynamic client registration.
|
com.nimbusds.oauth2.sdk.token |
OAuth 2.0 access and refresh token implementations.
|
com.nimbusds.openid.connect.sdk |
Classes for representing, serialising and parsing OpenID Connect client
requests and server responses.
|
Modifier and Type | Method | Description |
---|---|---|
Scope |
AuthorizationRequest.getScope() |
Gets the scope.
|
Scope |
TokenIntrospectionSuccessResponse.getScope() |
Returns the scope of the token.
|
Scope |
TokenRequest.getScope() |
Returns the requested scope.
|
static Scope |
Scope.parse(String s) |
Parses a scope from the specified string representation.
|
static Scope |
Scope.parse(Collection<String> collection) |
Parses a scope from the specified string collection representation.
|
Modifier and Type | Method | Description |
---|---|---|
AuthorizationRequest.Builder |
AuthorizationRequest.Builder.scope(Scope scope) |
Sets the scope.
|
TokenIntrospectionSuccessResponse.Builder |
TokenIntrospectionSuccessResponse.Builder.scope(Scope scope) |
Sets the token scope.
|
Constructor | Description |
---|---|
AuthorizationRequest(URI uri,
ResponseType rt,
ResponseMode rm,
ClientID clientID,
URI redirectURI,
Scope scope,
State state) |
Creates a new authorisation request.
|
AuthorizationRequest(URI uri,
ResponseType rt,
ResponseMode rm,
ClientID clientID,
URI redirectURI,
Scope scope,
State state,
CodeChallenge codeChallenge,
CodeChallengeMethod codeChallengeMethod,
List<URI> resources,
boolean includeGrantedScopes,
Map<String,List<String>> customParams) |
Creates a new authorisation request with extension and custom
parameters.
|
Scope(Scope scope) |
Creates a new scope from the specified scope.
|
TokenRequest(URI uri,
ClientAuthentication clientAuth,
AuthorizationGrant authzGrant,
Scope scope) |
Creates a new token request with the specified client
authentication.
|
TokenRequest(URI uri,
ClientAuthentication clientAuth,
AuthorizationGrant authzGrant,
Scope scope,
List<URI> resources,
Map<String,List<String>> customParams) |
Creates a new token request with the specified client
authentication and extension and custom parameters.
|
TokenRequest(URI uri,
AuthorizationGrant authzGrant,
Scope scope) |
Creates a new token request, without client authentication and a
specified client identifier.
|
TokenRequest(URI uri,
ClientID clientID,
AuthorizationGrant authzGrant,
Scope scope) |
Creates a new token request, with no explicit client authentication
(may be present in the grant depending on its type).
|
TokenRequest(URI uri,
ClientID clientID,
AuthorizationGrant authzGrant,
Scope scope,
List<URI> resources,
RefreshToken existingGrant,
Map<String,List<String>> customParams) |
Creates a new token request, with no explicit client authentication
(may be present in the grant depending on its type) and extension
and custom parameters.
|
Modifier and Type | Method | Description |
---|---|---|
Scope |
AuthorizationServerMetadata.getScopes() |
Gets the supported scope values.
|
Modifier and Type | Method | Description |
---|---|---|
void |
AuthorizationServerMetadata.setScopes(Scope scope) |
Sets the supported scope values.
|
Modifier and Type | Method | Description |
---|---|---|
Scope |
ClientMetadata.getScope() |
Gets the scope values that the client can use when requesting access
tokens.
|
Modifier and Type | Method | Description |
---|---|---|
void |
ClientMetadata.setScope(Scope scope) |
Sets the scope values that the client can use when requesting access
tokens.
|
Modifier and Type | Method | Description |
---|---|---|
Scope |
AccessToken.getScope() |
Returns the scope of this access token.
|
Scope |
BearerTokenError.getScope() |
Gets the required scope.
|
Modifier and Type | Method | Description |
---|---|---|
static boolean |
BearerTokenError.isScopeWithValidChars(Scope scope) |
Returns
true if the specified scope consists of valid
characters. |
BearerTokenError |
BearerTokenError.setScope(Scope scope) |
Sets the required scope.
|
Constructor | Description |
---|---|
AccessToken(AccessTokenType type,
int byteLength,
long lifetime,
Scope scope) |
Creates a new access token with a randomly generated value
of the specified byte length, Base64URL-encoded, and optional
lifetime and scope.
|
AccessToken(AccessTokenType type,
long lifetime,
Scope scope) |
Creates a new access token with a randomly generated 256-bit
(32-byte) value, Base64URL-encoded.
|
AccessToken(AccessTokenType type,
String value,
long lifetime,
Scope scope) |
Creates a new access token with the specified value and optional
lifetime and scope.
|
BearerAccessToken(int byteLength,
long lifetime,
Scope scope) |
Creates a new bearer access token with a randomly generated value of
the specified byte length, Base64URL-encoded.
|
BearerAccessToken(long lifetime,
Scope scope) |
Creates a new bearer access token with a randomly generated 256-bit
(32-byte) value, Base64URL-encoded.
|
BearerAccessToken(String value,
long lifetime,
Scope scope) |
Creates a new bearer access token with the specified value and
optional lifetime and scope.
|
BearerTokenError(String code,
String description,
int httpStatusCode,
URI uri,
String realm,
Scope scope) |
Creates a new OAuth 2.0 bearer token error with the specified code,
description, HTTP status code, page URI, realm and scope.
|
Modifier and Type | Method | Description |
---|---|---|
static ClaimsRequest |
ClaimsRequest.resolve(ResponseType responseType,
Scope scope) |
Resolves the claims request for the specified response type and
scope.
|
static ClaimsRequest |
ClaimsRequest.resolve(ResponseType responseType,
Scope scope,
ClaimsRequest claimsRequest) |
Resolves the merged claims request from the specified OpenID
authentication request parameters.
|
static ClaimsRequest |
ClaimsRequest.resolve(ResponseType responseType,
Scope scope,
ClaimsRequest claimsRequest,
Map<Scope.Value,Set<String>> customClaims) |
Resolves the merged claims request from the specified OpenID
authentication request parameters.
|
static ClaimsRequest |
ClaimsRequest.resolve(ResponseType responseType,
Scope scope,
Map<Scope.Value,Set<String>> customClaims) |
Resolves the claims request for the specified response type and
scope.
|
Constructor | Description |
---|---|
AuthenticationRequest(URI uri,
ResponseType rt,
ResponseMode rm,
Scope scope,
ClientID clientID,
URI redirectURI,
State state,
Nonce nonce,
Display display,
Prompt prompt,
int maxAge,
List<com.nimbusds.langtag.LangTag> uiLocales,
List<com.nimbusds.langtag.LangTag> claimsLocales,
com.nimbusds.jwt.JWT idTokenHint,
String loginHint,
List<ACR> acrValues,
ClaimsRequest claims,
com.nimbusds.jwt.JWT requestObject,
URI requestURI,
CodeChallenge codeChallenge,
CodeChallengeMethod codeChallengeMethod,
List<URI> resources,
boolean includeGrantedScopes,
Map<String,List<String>> customParams) |
Creates a new OpenID Connect authentication request with extension
and custom parameters.
|
AuthenticationRequest(URI uri,
ResponseType rt,
Scope scope,
ClientID clientID,
URI redirectURI,
State state,
Nonce nonce) |
Creates a new minimal OpenID Connect authentication request.
|
Builder(ResponseType rt,
Scope scope,
ClientID clientID,
URI redirectURI) |
Creates a new OpenID Connect authentication request builder.
|
Copyright © 2018 Connect2id Ltd.. All rights reserved.