Authlete
ClientExtension Class Reference

Extended information about a client application. More...

Properties

bool IsRequestableScopesEnabled [get, set]
 The flag which indicates whether "Requestable Scopes per Client" feature is enabled or not. More...
 
string[] RequestableScopes [get, set]
 The set of scopes that the client application can request when "Requestable Scopes per Client" feature is enabled (= when the IsRequestableScopesEnabled property returns true. More...
 
long AccessTokenDuration [get, set]
 The value of the duration of access tokens per client in seconds. More...
 
long RefreshTokenDuration [get, set]
 The value of the duration of refresh tokens per client in seconds. More...
 

Detailed Description

Extended information about a client application.

There are some attributes that belong to a client application but should not be changed by the developer of the client application. This class holds such attributes.

For example, an authorization server may narrow the range of scopes (permissions) that a particular client application can request. In this case, it is meaningless if the developer of the client application can freely decide the set of requestable scopes. It is not the developer of the client application but the administrator of the authorization server that should be allowed to define the set of scopes that the client application can request.

Property Documentation

◆ AccessTokenDuration

long AccessTokenDuration
getset

The value of the duration of access tokens per client in seconds.

In normal cases, the value of the AccessTokenDuration property of Service is used as the duration of access tokens issued by the service. However, if this AccessTokenDuration property holds a non-zero positive number and its value is less than the duration configured by the service, the value is used as the duration of access tokens issued to the client application.

Note that the duration of access tokens can be controlled by the scope attribute access_token.duration, too. Authlete chooses the minimum value among the candidates.

Since version 1.4.0.

◆ IsRequestableScopesEnabled

bool IsRequestableScopesEnabled
getset

The flag which indicates whether "Requestable Scopes per Client" feature is enabled or not.

If this property returns true, a special set of scopes (permissions) is defined on the server side (the RequestableScopes represents the special set) and scopes which the client application can request are limited to the scopes listed in the set. In other words, the application cannot request scopes that are not included in the special set. To be specific, the client application cannot list other scopes in the scope request parameter when it makes an authorization request. To be exact, other scopes can be listed but will be ignored by the authorization server.

On the other hand, if this property returns false, the valid set of scopes (permissions) that the client application can request is equal to the whole scope set defined by the authorization server.

◆ RefreshTokenDuration

long RefreshTokenDuration
getset

The value of the duration of refresh tokens per client in seconds.

In normal cases, the value of the RefreshTokenDuration property of Service is used as the duration of refresh tokens issued by the service. However, if this RefreshTokenDuration property holds a non-zero positive number and its value is less than the duration configured by the service, the value is used as the duration of refresh tokens issued to the client application.

Note that the duration of refresh tokens can be controlled by the scope attribute refresh_token.duration, too. Authlete chooses the minimum value among the candidates.

Since version 1.4.0.

◆ RequestableScopes

string [] RequestableScopes
getset

The set of scopes that the client application can request when "Requestable Scopes per Client" feature is enabled (= when the IsRequestableScopesEnabled property returns true.


The documentation for this class was generated from the following file: