io.vertx.ext.auth.oauth2.authorization

## Interface ScopeAuthorization

- All Superinterfaces:
    AuthorizationProvider

      public interface ScopeAuthorization
      extends AuthorizationProvider

  Scope is a mechanism in OAuth 2.0 to limit an application's access to a user's account. An application can request one or more scopes, this information is then presented to the user in the consent screen, and the access token issued to the application will be limited to the scopes granted. The OAuth spec allows the authorization server or user to modify the scopes granted to the application compared to what is requested, although there are not many examples of services doing this in practice. OAuth2 does not define any particular values for scopes, since it is highly dependent on the service's internal architecture and needs.
  Author:
    Paulo Lopes.

- - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `claimKey()` Returns the configured claim key.
    `static ScopeAuthorization` | `create(String scopeSeparator)` Factory method to create a Authorization provider for Oauth 2.0 scopes.
    `static ScopeAuthorization` | `create(String scopeSeparator, String claimKey)` Factory method to create a Authorization provider for OpenID Connect scopes.
    `String` | `encode(List<String> scopes)` Returns a String with the given scopes concatenated with the given separator.
    `String` | `separator()` Returns the configured separator.

    - ### Methods inherited from interface io.vertx.ext.auth.authorization.AuthorizationProvider

      `create, getAuthorizations, getAuthorizations, getId`

- - ### Method Detail

    - #### create

          static ScopeAuthorization create(String scopeSeparator)

      Factory method to create a Authorization provider for Oauth 2.0 scopes.
      Parameters:
        `scopeSeparator` - the scope separator e.g.: `" "`, `","`, `"+"`
      Returns:
        a AuthorizationProvider

    - #### create

          static ScopeAuthorization create(String scopeSeparator,
                                           String claimKey)

      Factory method to create a Authorization provider for OpenID Connect scopes. The claim key will be used to locate the scopes from a decoded JWT.
      Parameters:
        `scopeSeparator` - the scope separator e.g.: `" "`, `","`, `"+"`
        `claimKey` - the scope claim key e.g.: `"scp"`, `"scope"`
      Returns:
        a AuthorizationProvider

    - #### separator

          String separator()

      Returns the configured separator.
      Returns:
        the separator.

    - #### claimKey

          String claimKey()

      Returns the configured claim key.
      Returns:
        the claim key.

    - #### encode

          String encode(List<String> scopes)

      Returns a String with the given scopes concatenated with the given separator.
      Parameters:
        `scopes` - a list of scopes
      Returns:
        concatenated string.

Copyright © 2021 Eclipse. All rights reserved.