Class UserResource

Hierarchy

  • UserResource

Constructors

constructor

Properties

active? displayName? emails? groups? id? meta? name? photos? preferredLanguage? roles? schemas? urnietfparamsscimschemasextensionenterprise20User? userName? userType?

Constructors

constructor

Properties

Optional active

active?: boolean

Indicates whether the user is active or deactivated in the organization.

Optional displayName

displayName?: string

A human-readable name for the user, typically the full name.

Optional emails

emails?: UserResourceEmailsInner[]

An array of email addresses, each an object with a value, display and primary flag.

Optional groups

groups?: UserResourceGroupsInner[]

An array of groups (teams) the user belongs to in the organization. Contains id and display name of the team.

Optional id

id?: string

A server-assigned, unique identifier for this user.

Optional meta

meta?: UserResourceMeta

Optional name

name?: UserResourceName

Optional photos

photos?: UserResourcePhotosInner[]

An array for profile pictures, contains type.

Optional preferredLanguage

preferredLanguage?: string

Specifies the users preferred language.

Example: en_US for English.

Optional roles

roles?: UserResourceRolesInner[]

An array of roles assigned to the user in the organization. Contains role type, value, display and primary flag.

Optional schemas

schemas?: string[]

Identifies which schema(s) this resource uses. In this case it is the SCIM core User schema.

Optional urnietfparamsscimschemasextensionenterprise20User

urnietfparamsscimschemasextensionenterprise20User?: UserResourceUrnIetfParamsScimSchemasExtensionEnterprise20User

Optional userName

userName?: string

The unique username/login identifier. An email address in this case.

Optional userType

userType?: string

Free-form string to indicate the user license type in the organization.

@mirohq/miro-api