OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:111

OAuth scopes that are allowed with this client.

See

https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-idp-settings.html

Properties

scopeName

readonly scopeName: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:150

The name of this scope as recognized by CloudFormation.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes

---

COGNITO_ADMIN

readonly static COGNITO_ADMIN: OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:135

Grants access to Amazon Cognito User Pool API operations that require access tokens, such as UpdateUserAttributes and VerifyUserAttribute.

---

EMAIL

readonly static EMAIL: OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:121

Grants access to the ‘email’ and ‘email_verified’ claims. Automatically includes access to OAuthScope.OPENID.

---

OPENID

readonly static OPENID: OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:125

Returns all user attributes in the ID token that are readable by the client

---

PHONE

readonly static PHONE: OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:116

Grants access to the ‘phone_number’ and ‘phone_number_verified’ claims. Automatically includes access to OAuthScope.OPENID.

---

PROFILE

readonly static PROFILE: OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:130

Grants access to all user attributes that are readable by the client Automatically includes access to OAuthScope.OPENID.

Methods

custom()

static custom(name): OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:141

Custom scope is one that you define for your own resource server in the Resource Servers. The format is ‘resource-server-identifier/scope’.

Parameters

name

string

Returns

OAuthScope

See

https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html

---

resourceServer()

static resourceServer(server, scope): OAuthScope

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-cognito/lib/user-pool-client.d.ts:145

Adds a custom scope that’s tied to a resource server in your stack

Parameters

server

IUserPoolResourceServer

scope

ResourceServerScope

Returns

OAuthScope