Scope (List)#

Path: /profiles/profile{id, type}/settings/authorization-server/scopes/scope

Parameters#

NameTypeRequiredDefaultDescription
idscoperequired
is-prefixbooleanoptionalfalseWhether this is a prefix scope. Prefix scopes allow clients to use dynamic scopes that start with a prefix, but may have any value after that.
descriptionstringoptional
time-to-liveuint32optionalThe number of seconds a scope will be valid
requiredbooleanoptionalfalseWhether the scope is required in the request (but not necessarily granted) when configured for any client in the profile or during registration of a non-templatized dynamic clients when all scopes or this scope in particular is allowed to be registered by dynamic clients.
expose-in-metadatabooleanoptionaltrueExpose this scope as part of the published metadata.
claimsmulti-value, leafrefoptionalThe claims that are issued when the client is granted this scope of access

Subsections#

NameTypeDescription
properties SectionNone

Was this helpful?