Uses of Class
com.nimbusds.oauth2.sdk.Scope
-
Packages that use Scope Package Description com.nimbusds.oauth2.sdk Classes for representing, serialising and parsing core OAuth 2.0 concepts.com.nimbusds.oauth2.sdk.as OAuth 2.0 Authorisation Server (AS) classes.com.nimbusds.oauth2.sdk.ciba OpenID Connect Client Initiated Backchannel Authentication (CIBA) Flow - Core 1.0 classes.com.nimbusds.oauth2.sdk.client OAuth 2.0 dynamic client registration.com.nimbusds.oauth2.sdk.device OAuth 2.0 device authorisation grant classes.com.nimbusds.oauth2.sdk.token OAuth 2.0 access and refresh token implementations.com.nimbusds.openid.connect.sdk Classes for representing, serialising and parsing core OpenID Connect concepts. -
-
Uses of Scope in com.nimbusds.oauth2.sdk
Methods in com.nimbusds.oauth2.sdk that return Scope Modifier and Type Method Description Scope
AuthorizationRequest. getScope()
Returns 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.Methods in com.nimbusds.oauth2.sdk with parameters of type Scope 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.Constructors in com.nimbusds.oauth2.sdk with parameters of type 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<AuthorizationDetail> authorizationDetails, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, Map<String,List<String>> customParams)
Creates a new authorisation request with extension and custom parameters.AuthorizationRequest(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, Map<String,List<String>> customParams)
Deprecated.AuthorizationRequest(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, JWKThumbprintConfirmation dpopJKT, Map<String,List<String>> customParams)
Deprecated.AuthorizationRequest(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, Map<String,List<String>> customParams)
Deprecated.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<AuthorizationDetail> authorizationDetails, 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, 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 (maybe present in the grant depending on its type).TokenRequest(URI uri, ClientID clientID, AuthorizationGrant authzGrant, Scope scope, List<AuthorizationDetail> authorizationDetails, List<URI> resources, RefreshToken existingGrant, Map<String,List<String>> customParams)
Creates a new token request, with no explicit client authentication (maybe present in the grant depending on its type) and extension and custom parameters.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 (maybe present in the grant depending on its type) and extension and custom parameters. -
Uses of Scope in com.nimbusds.oauth2.sdk.as
Methods in com.nimbusds.oauth2.sdk.as that return Scope Modifier and Type Method Description Scope
AuthorizationServerMetadata. getScopes()
Scope
ReadOnlyAuthorizationServerMetadata. getScopes()
Gets the supported scope values.Methods in com.nimbusds.oauth2.sdk.as with parameters of type Scope Modifier and Type Method Description void
AuthorizationServerMetadata. setScopes(Scope scope)
Sets the supported scope values. -
Uses of Scope in com.nimbusds.oauth2.sdk.ciba
Methods in com.nimbusds.oauth2.sdk.ciba that return Scope Modifier and Type Method Description Scope
CIBARequest. getScope()
Returns the scope.Constructors in com.nimbusds.oauth2.sdk.ciba with parameters of type Scope Constructor Description Builder(ClientAuthentication clientAuth, Scope scope)
Creates a new CIBA request builder.CIBARequest(URI uri, ClientAuthentication clientAuth, Scope scope, BearerAccessToken clientNotificationToken, List<ACR> acrValues, String loginHintTokenString, com.nimbusds.jwt.JWT idTokenHint, String loginHint, String bindingMessage, Secret userCode, Integer requestedExpiry, OIDCClaimsRequest claims, List<com.nimbusds.langtag.LangTag> claimsLocales, String purpose, List<URI> resources, Map<String,List<String>> customParams)
Creates a new CIBA request.CIBARequest(URI uri, ClientAuthentication clientAuth, Scope scope, BearerAccessToken clientNotificationToken, List<ACR> acrValues, String loginHintTokenString, com.nimbusds.jwt.JWT idTokenHint, String loginHint, String bindingMessage, Secret userCode, Integer requestedExpiry, OIDCClaimsRequest claims, Map<String,List<String>> customParams)
Deprecated.CIBARequest(URI uri, ClientAuthentication clientAuth, Scope scope, BearerAccessToken clientNotificationToken, List<ACR> acrValues, String loginHintTokenString, com.nimbusds.jwt.JWT idTokenHint, String loginHint, String bindingMessage, Secret userCode, Integer requestedExpiry, Map<String,List<String>> customParams)
Deprecated. -
Uses of Scope in com.nimbusds.oauth2.sdk.client
Methods in com.nimbusds.oauth2.sdk.client that return Scope Modifier and Type Method Description Scope
ClientMetadata. getScope()
Gets the scope values that the client can use when requesting access tokens.Methods in com.nimbusds.oauth2.sdk.client with parameters of type Scope Modifier and Type Method Description void
ClientMetadata. setScope(Scope scope)
Sets the scope values that the client can use when requesting access tokens. -
Uses of Scope in com.nimbusds.oauth2.sdk.device
Methods in com.nimbusds.oauth2.sdk.device that return Scope Modifier and Type Method Description Scope
DeviceAuthorizationRequest. getScope()
Gets the scope.Methods in com.nimbusds.oauth2.sdk.device with parameters of type Scope Modifier and Type Method Description DeviceAuthorizationRequest.Builder
DeviceAuthorizationRequest.Builder. scope(Scope scope)
Sets the scope.Constructors in com.nimbusds.oauth2.sdk.device with parameters of type Scope Constructor Description DeviceAuthorizationRequest(URI uri, ClientAuthentication clientAuth, Scope scope, Map<String,List<String>> customParams)
Creates a new authenticated device authorization request with extension and custom parameters.DeviceAuthorizationRequest(URI uri, ClientID clientID, Scope scope)
Creates a new device authorization request.DeviceAuthorizationRequest(URI uri, ClientID clientID, Scope scope, Map<String,List<String>> customParams)
Creates a new device authorization request with extension and custom parameters. -
Uses of Scope in com.nimbusds.oauth2.sdk.token
Methods in com.nimbusds.oauth2.sdk.token that return Scope Modifier and Type Method Description Scope
AccessToken. getScope()
Returns the scope of this access token.Scope
TokenSchemeError. getScope()
Returns the required scope.Methods in com.nimbusds.oauth2.sdk.token with parameters of type Scope Modifier and Type Method Description static boolean
TokenSchemeError. isScopeWithValidChars(Scope scope)
Returnstrue
if the specified scope consists of valid characters.BearerTokenError
BearerTokenError. setScope(Scope scope)
DPoPTokenError
DPoPTokenError. setScope(Scope scope)
abstract TokenSchemeError
TokenSchemeError. setScope(Scope scope)
Sets the required scope.Constructors in com.nimbusds.oauth2.sdk.token with parameters of type 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.AccessToken(AccessTokenType type, int byteLength, long lifetime, Scope scope, TokenTypeURI issuedTokenType)
Creates a new access token with a randomly generated value of the specified byte length, Base64URL-encoded.AccessToken(AccessTokenType type, int byteLength, long lifetime, Scope scope, List<AuthorizationDetail> authorizationDetails, TokenTypeURI issuedTokenType)
Creates a new access token with a randomly generated value of the specified byte length, Base64URL-encoded.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.AccessToken(AccessTokenType type, String value, long lifetime, Scope scope, TokenTypeURI issuedTokenType)
Creates a new access token with the specified value.AccessToken(AccessTokenType type, String value, long lifetime, Scope scope, List<AuthorizationDetail> authorizationDetails, TokenTypeURI issuedTokenType)
Creates a new access token with the specified value.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.BearerAccessToken(String value, long lifetime, Scope scope, TokenTypeURI issuedTokenType)
Creates a new bearer access token with the specified value.BearerAccessToken(String value, long lifetime, Scope scope, List<AuthorizationDetail> authorizationDetails, TokenTypeURI issuedTokenType)
Creates a new bearer access token with the specified value.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.DPoPAccessToken(String value, long lifetime, Scope scope)
Creates a new DPoP access token with the specified value.DPoPAccessToken(String value, long lifetime, Scope scope, TokenTypeURI issuedTokenType)
Creates a new DPoP access token with the specified value.DPoPAccessToken(String value, long lifetime, Scope scope, List<AuthorizationDetail> authorizationDetails, TokenTypeURI issuedTokenType)
Creates a new DPoP access token with the specified value.DPoPTokenError(String code, String description, int httpStatusCode, URI uri, String realm, Scope scope)
Creates a new OAuth 2.0 DPoP token error with the specified code, description, HTTP status code, page URI, realm and scope.DPoPTokenError(String code, String description, int httpStatusCode, URI uri, String realm, Scope scope, Set<com.nimbusds.jose.JWSAlgorithm> jwsAlgs)
Creates a new OAuth 2.0 DPoP token error with the specified code, description, HTTP status code, page URI, realm and scope.NAAccessToken(String value, long lifetime, Scope scope, TokenTypeURI issuedTokenType)
Creates a new N/A access token with the specified value.TokenSchemeError(AccessTokenType scheme, String code, String description, int httpStatusCode, URI uri, String realm, Scope scope)
Creates a new token error with the specified code, description, HTTP status code, page URI, realm and scope. -
Uses of Scope in com.nimbusds.openid.connect.sdk
Methods in com.nimbusds.openid.connect.sdk with parameters of type Scope Modifier and Type Method Description static ClaimsRequest
ClaimsRequest. resolve(ResponseType responseType, Scope scope)
Deprecated.Resolves the claims request for the specified response type and scope.static ClaimsRequest
ClaimsRequest. resolve(ResponseType responseType, Scope scope, ClaimsRequest claimsRequest)
Deprecated.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)
Deprecated.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)
Deprecated.Resolves the claims request for the specified response type and scope.static OIDCClaimsRequest
OIDCClaimsRequest. resolve(ResponseType responseType, Scope scope)
Resolves the OpenID claims request for the specified response type and scope.static OIDCClaimsRequest
OIDCClaimsRequest. resolve(ResponseType responseType, Scope scope, OIDCClaimsRequest claimsRequest)
Resolves the merged OpenID claims request from the specified OpenID authentication request parameters.static OIDCClaimsRequest
OIDCClaimsRequest. resolve(ResponseType responseType, Scope scope, OIDCClaimsRequest claimsRequest, Map<Scope.Value,Set<String>> customClaims)
Resolves the merged OpenID claims request from the specified OpenID authentication request parameters.static OIDCClaimsRequest
OIDCClaimsRequest. resolve(ResponseType responseType, Scope scope, Map<Scope.Value,Set<String>> customClaims)
Resolves the OpenID claims request for the specified response type and scope.AuthenticationRequest.Builder
AuthenticationRequest.Builder. scope(Scope scope)
Sets the scope.Constructors in com.nimbusds.openid.connect.sdk with parameters of type 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, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String,List<String>> customParams)
Deprecated.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, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String,List<String>> customParams)
Deprecated.AuthenticationRequest(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, JWKThumbprintConfirmation dpopJKT, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String,List<String>> customParams)
Deprecated.AuthenticationRequest(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<AuthorizationDetail> authorizationDetails, 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, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String,List<String>> customParams)
Deprecated.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.
-