Skip to main content

Type Alias: ConsentScope

ConsentScope = object

Defined in: OAuthConsent/OAuthConsent.tsx:18

A single OAuth scope, optionally with implied child scopes.

Properties​

children?​

optional children?: ConsentScope[]

Defined in: OAuthConsent/OAuthConsent.tsx:29

Child scopes implied by this one. When this scope is granted, every descendant is granted and locked (checked + disabled).


defaultGranted?​

optional defaultGranted?: boolean

Defined in: OAuthConsent/OAuthConsent.tsx:34

Pre-checked on mount.

Default​

false

description​

description: string

Defined in: OAuthConsent/OAuthConsent.tsx:24

Scope description shown below the label. Pre-translated by the consumer.


key​

key: string

Defined in: OAuthConsent/OAuthConsent.tsx:20

OAuth scope token, e.g. 'repo', 'write:packages', 'read'.


label​

label: string

Defined in: OAuthConsent/OAuthConsent.tsx:22

Bold display name shown on the left. Pre-translated by the consumer.


required?​

optional required?: boolean

Defined in: OAuthConsent/OAuthConsent.tsx:39

Always granted; cannot be unchecked. Renders checked + disabled.

Default​

false