Share via

UserCreateParameterProperties interface

  • Reference
Package:
@azure/arm-apimanagement

Parameters supplied to the Create User operation.

Extends
UserEntityBaseParameters

Properties

appType

Determines the type of application which send the create user request. Default is legacy portal.
confirmation

Determines the type of confirmation e-mail that will be sent to the newly created user.
email

Email address. Must not be empty and must be unique within the service instance.
firstName

First name.
lastName

Last name.
password

User Password. If no value is provided, a default password is generated.

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

appType

Determines the type of application which send the create user request. Default is legacy portal.

appType?: string

Property Value

string

confirmation

Determines the type of confirmation e-mail that will be sent to the newly created user.

confirmation?: string

Property Value

string

email

Email address. Must not be empty and must be unique within the service instance.

email: string

Property Value

string

firstName

First name.

firstName: string

Property Value

string

lastName

Last name.

lastName: string

Property Value

string

password

User Password. If no value is provided, a default password is generated.

password?: string

Property Value

string

Inherited Property Details

identities

Collection of user identities.

identities?: UserIdentityContract[]

Property Value

UserIdentityContract[]

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