Package org.keycloak.protocol.oidc.scope

Class DelegationScopeType

java.lang.Object
org.keycloak.protocol.oidc.scope.UsernameScopeType
org.keycloak.protocol.oidc.scope.DelegationScopeType
All Implemented Interfaces:
org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider>
public class DelegationScopeType extends UsernameScopeType
Author:
rmartinc

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE
     

    Fields inherited from class org.keycloak.protocol.oidc.scope.UsernameScopeType

    session

  • Constructor Summary

    Constructors
    Constructor
    Description
    DelegationScopeType()
     
    DelegationScopeType(org.keycloak.models.KeycloakSession session)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canAccessTargetUser(org.keycloak.models.ClientScopeModel scope, org.keycloak.models.UserModel currentUser, org.keycloak.models.UserModel targetUser)
    Checks whether the authenticated user is allowed to access the target user's data for this scope.
    org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider
    create(org.keycloak.models.KeycloakSession session)
     
    String
    getTypeName()
     
    boolean
    isRepeatable()
     
    void
    validateParameterWithUser(org.keycloak.models.UserModel currentUser, org.keycloak.models.ClientScopeModel scope, String parameter)
     

    Methods inherited from class org.keycloak.protocol.oidc.scope.UsernameScopeType

    resolveUser, validateParameter

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider

    close, getId, init, postInit

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, getConfigMetadata, order

  • Field Details

  • Constructor Details

    • DelegationScopeType

      public DelegationScopeType()

    • DelegationScopeType

      public DelegationScopeType(org.keycloak.models.KeycloakSession session)

  • Method Details

    • getTypeName

      public String getTypeName()
      Specified by:
      getTypeName in interface org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider
      Overrides:
      getTypeName in class UsernameScopeType

    • isRepeatable

      public boolean isRepeatable()

    • canAccessTargetUser

      public boolean canAccessTargetUser(org.keycloak.models.ClientScopeModel scope, org.keycloak.models.UserModel currentUser, org.keycloak.models.UserModel targetUser)
      Description copied from class: UsernameScopeType
      Checks whether the authenticated user is allowed to access the target user's data for this scope.
      Overrides:
      canAccessTargetUser in class UsernameScopeType

    • create

      public org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider create(org.keycloak.models.KeycloakSession session)
      Specified by:
      create in interface org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider
      Specified by:
      create in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider>
      Overrides:
      create in class UsernameScopeType

    • validateParameterWithUser

      public void validateParameterWithUser(@Nonnull org.keycloak.models.UserModel currentUser, @Nonnull org.keycloak.models.ClientScopeModel scope, @Nonnull String parameter) throws org.keycloak.protocol.oidc.scope.InvalidScopeParameterException
      Specified by:
      validateParameterWithUser in interface org.keycloak.protocol.oidc.scope.ParameterizedScopeTypeProvider
      Overrides:
      validateParameterWithUser in class UsernameScopeType
      Throws:
      org.keycloak.protocol.oidc.scope.InvalidScopeParameterException