Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

User

import type { User } from "https://aws-api.deno.dev/v0.3/services/quicksight.ts?docs=full";

A registered user of Amazon QuickSight.

interface User {
Active?: boolean | null;
Arn?: string | null;
CustomPermissionsName?: string | null;
Email?: string | null;
ExternalLoginFederationProviderType?: string | null;
ExternalLoginFederationProviderUrl?: string | null;
ExternalLoginId?: string | null;
IdentityType?: IdentityType | null;
PrincipalId?: string | null;
Role?: UserRole | null;
UserName?: string | null;
}

§Properties

§
Active?: boolean | null
[src]

The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

§
Arn?: string | null
[src]

The Amazon Resource Name (ARN) for the user.

§
CustomPermissionsName?: string | null
[src]

The custom permissions profile associated with this user.

§
Email?: string | null
[src]

The user's email address.

§
ExternalLoginFederationProviderType?: string | null
[src]

The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
§
ExternalLoginFederationProviderUrl?: string | null
[src]

The URL of the external login provider.

§
ExternalLoginId?: string | null
[src]

The identity ID for the user in the external login provider.

§
IdentityType?: IdentityType | null
[src]

The type of identity authentication used by the user.

§
PrincipalId?: string | null
[src]

The principal ID of the user.

§
Role?: UserRole | null
[src]

The Amazon QuickSight role for the user. The user role can be one of the following:.

  • READER: A user who has read-only access to dashboards.
  • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
  • ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
  • RESTRICTED_READER: This role isn't currently available for use.
  • RESTRICTED_AUTHOR: This role isn't currently available for use.
§
UserName?: string | null
[src]

The user's user name. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.