Type Alias UserPostSchema

{
* assignedRoles: [
* {
* name: "Developer"
* }
* ],
* email: "john.smith@corp.example",
* name: "John Smith",
* picture: "https://corp.example/docs/jsmith.png",
* status: "invited",
* subject: "1234asdasa6789",
* tenantId: "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f"
* }
type UserPostSchema = {
    assignedRoles?: RefIDs | RefNames;
    email?: string;
    name?: string;
    picture?: string;
    status?: "invited";
    subject: string;
    tenantId?: string;
}
Index

Properties

assignedRoles?: RefIDs | RefNames

The roles to assign to the user.

email?: string

The email address for the user. This is a required field when inviting a user.

name?: string

The name of the user.

picture?: string

A static url linking to the avatar of the user.

status?: "invited"

The status of the created user within the tenant.

subject: string

The unique user identitier from an identity provider.

tenantId?: string

The tenant that the user will belong too.