UserContractProperties interface

User profile.

Extends

Properties

email

Email address.

firstName

First name.

groups

Collection of groups user is part of. NOTE: This property will not be serialized. It can only be populated by the server.

lastName

Last name.

registrationDate

Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Inherited Properties

identities

Collection of user identities.

note

Optional note about a user set by the administrator.

state

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

Property Details

email

Email address.

email?: string

Property Value

string

firstName

First name.

firstName?: string

Property Value

string

groups

Collection of groups user is part of. NOTE: This property will not be serialized. It can only be populated by the server.

groups?: GroupContractProperties[]

Property Value

lastName

Last name.

lastName?: string

Property Value

string

registrationDate

Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

registrationDate?: Date

Property Value

Date

Inherited Property Details

identities

Collection of user identities.

identities?: UserIdentityContract[]

Property Value

Inherited From UserEntityBaseParameters.identities

note

Optional note about a user set by the administrator.

note?: string

Property Value

string

Inherited From UserEntityBaseParameters.note

state

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

state?: string

Property Value

string

Inherited From UserEntityBaseParameters.state