Package io.micronaut.security.oauth2.endpoint.authorization.request

Enum Class OpenIdScope

java.lang.Object
java.lang.Enum<OpenIdScope>
io.micronaut.security.oauth2.endpoint.authorization.request.OpenIdScope
All Implemented Interfaces:
Serializable, Comparable<OpenIdScope>, Constable
public enum OpenIdScope extends Enum<OpenIdScope>
OpenID Connect scope values.
Since:
1.2.0
Author:
Sergio del Amo

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADDRESS
    This scope value requests access to the address Claim.
    EMAIL
    This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.
    OPENID
     
    PHONE
    This scope value requests access to the phone_number and phone_number_verified Claims.
    PROFILE
    This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
     
    static OpenIdScope
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OpenIdScope[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • OPENID

      public static final OpenIdScope OPENID

    • PROFILE

      public static final OpenIdScope PROFILE
      This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

    • EMAIL

      public static final OpenIdScope EMAIL
      This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

    • ADDRESS

      public static final OpenIdScope ADDRESS
      This scope value requests access to the address Claim.

    • PHONE

      public static final OpenIdScope PHONE
      This scope value requests access to the phone_number and phone_number_verified Claims.

  • Method Details

    • values

      public static OpenIdScope[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OpenIdScope valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<OpenIdScope>
      Returns:
      a string representation of the scope.