java.lang.Object
- java.lang.Enum<Scope>
- - org.cyclos.model.access.oidcclients.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, HasMessageKey
```
public enum Scope
extends Enum<Scope>
implements HasMessageKey
```
Supported OAuth 2 / OpenID Connect scopes

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ACCOUNT_HISTORY`	Get the full account history.
`ACCOUNT_STATUS`	Get the current account status.
`ADDRESS`	Standard address scope, which gives access to the user's physical address.
`ADS_READ`	View advertisements (simple and webshop), both of the own user and of other users.
`ADS_WRITE`	Manage advertisements (simple and webshop), as well as webshop settings, delivery methods, sales, etc.
`EMAIL`	Standard email scope, which gives access to the user's e-mail address.
`OFFLINE_ACCESS`	Standard offline access scope, which enables refresh tokens.
`OPENID`	Standard openid scope, which enables the OpenID Connect features.
`PAYMENT`	Perform payments.
`PHONE`	Standard phone scope, which gives access to the user's phone number.
`PROFILE`	Standard profile scope, which gives access to claims such as full name, login name, picture URL, custom fields and locale.
`PROFILE_READ`	Read the full user profile.
`PROFILE_WRITE`	Modify the full user profile.
`PURCHASE`	Add items to the shopping cart and purchase.
`TICKETS`	Create and manage tickets: `to`: Tickets to a specific user

Field Summary

Fields
Modifier and Type Field Description

static List<String> NAMES

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`dependsOnOpenid()`	Returns whether this scope requires the openid scope in order to be enabled
`MessageKey`	`getMessageKey()`
`List<String>`	`getParameters()`
`boolean`	`isAllowAdmins()`
`static boolean`	`isOidc(String scope)`	Indicates whether this scope, or list of scopes separated by spaces, are standard of the OpenID Connect protocol
`static Scope`	`of(String value)`	Returns a scope by value, or null if not found
`static Map<Scope,Map<String,String>>`	`parse(String scope)`	Parses each scope together with its parameters
`String`	`toString()`
`static Scope`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Scope[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OPENID
```
public static final Scope OPENID
```
    Standard openid scope, which enables the OpenID Connect features. When not requested, will be a plain OAuth2 authorization.
  - PROFILE
```
public static final Scope PROFILE
```
    Standard profile scope, which gives access to claims such as full name, login name, picture URL, custom fields and locale.
  - EMAIL
```
public static final Scope EMAIL
```
    Standard email scope, which gives access to the user's e-mail address.
  - PHONE
```
public static final Scope PHONE
```
    Standard phone scope, which gives access to the user's phone number.
  - ADDRESS
```
public static final Scope ADDRESS
```
    Standard address scope, which gives access to the user's physical address.
  - OFFLINE_ACCESS
```
public static final Scope OFFLINE_ACCESS
```
    Standard offline access scope, which enables refresh tokens.
  - ACCOUNT_STATUS
```
public static final Scope ACCOUNT_STATUS
```
    Get the current account status. Is never granted to administrators. Parameters:
    
    type: Restrict to a specific account type
  - ACCOUNT_HISTORY
```
public static final Scope ACCOUNT_HISTORY
```
    Get the full account history. Is never granted to administrators. Parameters:
    
    type: Restrict to a specific account type
  - PAYMENT
```
public static final Scope PAYMENT
```
    Perform payments. Is never granted to administrators. Parameters:
    
    to: Payments to a specific user
    
    amount: Payments with a specific amount
    
    currency: Payments with a specific currency. When an amount is specified, this must also be, unless the authenticated user have accounts in a single currency.
  - TICKETS
```
public static final Scope TICKETS
```
    Create and manage tickets:
    
    to: Tickets to a specific user
  - PROFILE_READ
```
public static final Scope PROFILE_READ
```
    Read the full user profile. Is never granted to administrators.
  - PROFILE_WRITE
```
public static final Scope PROFILE_WRITE
```
    Modify the full user profile. Is never granted to administrators.
  - ADS_READ
```
public static final Scope ADS_READ
```
    View advertisements (simple and webshop), both of the own user and of other users. Is never granted to administrators.
  - ADS_WRITE
```
public static final Scope ADS_WRITE
```
    Manage advertisements (simple and webshop), as well as webshop settings, delivery methods, sales, etc. Is never granted to administrators.
  - PURCHASE
```
public static final Scope PURCHASE
```
    Add items to the shopping cart and purchase. Also allows viewing the purchases.
- Field Detail
  - NAMES
```
public static List<String> NAMES
```
- Method Detail
  - values
```
public static Scope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Scope c : Scope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Scope valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isOidc
```
public static boolean isOidc(String scope)
```
    Indicates whether this scope, or list of scopes separated by spaces, are standard of the OpenID Connect protocol
  - of
```
public static Scope of(String value)
```
    Returns a scope by value, or null if not found
  - parse
```
public static Map<Scope,Map<String,String>> parse(String scope)
```
    Parses each scope together with its parameters
    
    Throws:
    
    IllegalArgumentException - If any scope name isn't recognized, of if a scope has an unrecognized parameter
  - dependsOnOpenid
```
public boolean dependsOnOpenid()
```
    Returns whether this scope requires the openid scope in order to be enabled
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey
  - getParameters
```
public List<String> getParameters()
```
  - isAllowAdmins
```
public boolean isAllowAdmins()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<Scope>

Enum Scope

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OPENID

PROFILE

EMAIL

PHONE

ADDRESS

OFFLINE_ACCESS

ACCOUNT_STATUS

ACCOUNT_HISTORY

PAYMENT

TICKETS

PROFILE_READ

PROFILE_WRITE

ADS_READ

ADS_WRITE

PURCHASE

Field Detail

NAMES

Method Detail

values

valueOf

isOidc

of

parse

dependsOnOpenid

getMessageKey

getParameters

isAllowAdmins

toString