Scopes are objects that contains authorization options and fields for customizing the scope of the authorization form. There are some universal scope parameters that can be set for all utilities, such as when the authorization expires, etc. There also utility-specific scope parameters, so please read the documentation for each utility if you want to add non-default scopes to an authorization.
The default scope ({}) uses the default parameters for each universal scope
parameter and each utility-specific scope parameter. In general, we try to keep defaults
as practical as possible so you don't have set custom scope in most cases.
// Example scope that expires in 3 years { "expires": "3y" }
| Scope | Format | Default | Description | Example |
|---|---|---|---|---|
expires |
Preset or Duration or ISO8601 | "3y" |
When the authorization expires. Can either be a preset string, duration, or a specific time. See below for available options.
Preset strings:
Durations:
ISO8601:
|
Preset string:
Duration:
ISO8601:
|
ongoing_end |
ISO8601 or null
|
null |
No data which has a timestamp later than this parameter will be collected. If
|
|
