Type Alias User

A user object.

type User = {
    assignedGroups?: AssignedGroups;
    assignedRoles?: AssignedRoles;
    assignedScopes?: AssignedScopes;
    created?: string;
    createdAt?: string;
    email?: string;
    id: string;
    inviteExpiry?: number;
    lastUpdated?: string;
    lastUpdatedAt?: string;
    links?: { self: { href: string } };
    locale?: string;
    name: string;
    picture?: string;
    preferredLocale?: string;
    preferredZoneinfo?: string;
    roles?: (
        | "TenantAdmin"
        | "Developer"
        | "AnalyticsAdmin"
        | "DataAdmin"
        | "DataSpaceCreator"
        | "ManagedSpaceCreator"
        | "SharedSpaceCreator"
    )[];
    status?: "active"
    | "invited"
    | "disabled"
    | "deleted"
    | "provisioned";
    subject: string;
    tenantId: string;
    zoneinfo?: string;
}
Index

Properties

assignedGroups? assignedRoles? assignedScopes? created? createdAt? email? id inviteExpiry? lastUpdated? lastUpdatedAt? links? locale? name picture? preferredLocale? preferredZoneinfo? roles? status? subject tenantId zoneinfo?

Properties

assignedGroups?: AssignedGroups

An array of group references.

assignedRoles?: AssignedRoles

An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.

assignedScopes?: AssignedScopes

An array of scopes assigned to a user

created?: string

Deprecated. Use createdAt instead.

createdAt?: string

The timestamp for when the user record was created.

email?: string

The email address for the user.

id: string

The unique user identifier.

inviteExpiry?: number

The Unix timestamp indicating when the invite will expire.

lastUpdated?: string

Deprecated. Use lastUpdatedAt instead.

lastUpdatedAt?: string

The timestamp for when the user record was last updated.

links?: { self: { href: string } }

Pagination links to the user.

Type declaration

  • self: { href: string }

    A link to this user.

    • href: string

      URL that defines the resource.

locale?: string

Represents the end-user's language tag.

name: string

The name of the user.

picture?: string

A static url linking to the avatar of the user.

preferredLocale?: string

Represents the end-user's preferred language tag.

preferredZoneinfo?: string

Represents the end-user's preferred time zone.

roles?: (
    | "TenantAdmin"
    | "Developer"
    | "AnalyticsAdmin"
    | "DataAdmin"
    | "DataSpaceCreator"
    | "ManagedSpaceCreator"
    | "SharedSpaceCreator"
)[]

List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use assignedRoles instead.

status?: "active" | "invited" | "disabled" | "deleted" | "provisioned"

The status of the user within the tenant.

subject: string

The unique user identitier from an identity provider.

tenantId: string

The tenant that the user belongs too.

zoneinfo?: string

Represents the end-user's time zone.

Settings

Member Visibility

On This Page

Properties