Microsoft.ApiManagement service/users 2018-01-01

Template format

To create a Microsoft.ApiManagement/service/users resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2018-01-01",
  "properties": {
    "state": "string",
    "note": "string",
    "identities": [
      {
        "provider": "string",
        "id": "string"
      }
    ],
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "password": "string",
    "confirmation": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/users object

Name Type Required Value
name string Yes User identifier. Must be unique in the current API Management service instance.
type enum Yes users
-or-
Microsoft.ApiManagement/service/users

See Set name and type for child resources.
apiVersion enum Yes 2018-01-01
properties object Yes User entity create contract properties. - UserCreateParameterProperties object

UserCreateParameterProperties object

Name Type Required Value
state enum No 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. - active, blocked, pending, deleted
note string No Optional note about a user set by the administrator.
identities array No Collection of user identities. - UserIdentityContract object
email string Yes Email address. Must not be empty and must be unique within the service instance.
firstName string Yes First name.
lastName string Yes Last name.
password string No User Password. If no value is provided, a default password is generated.
confirmation enum No Determines the type of confirmation e-mail that will be sent to the newly created user. - signup or invite

UserIdentityContract object

Name Type Required Value
provider string No Identity provider name.
id string No Identifier value within provider.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities