Create user

This API call creates a cluster user account.

Authentication

The ServiceProviderAPI (Service Provider API) Api-Token scope is required to get the default realm password policy configuration using the Dynatrace API. With this API method, you can preset user's password by passing passwordClearText value. This is allowed only if a specific Feature Flag is enabled. To do this, Please contact a Dynatrace ONE product specialist by selecting the chat button in the upper-right corner of the Dynatrace menu bar..

Endpoint

/api/v1.0/onpremise/users

Parameter

Parameter	Type	Description	In	Required
body	UserConfig	The JSON body of the request, containing parameters of the user.	body	optional

Request body objects

The `UserConfig` object

The configuration of the user.

Element	Type	Description	Required
email	string	User's email address	required
firstName	string	User's first name	required
groups	string[]	List of user's user group IDs.	optional
id	string	User ID	required
lastName	string	User's last name	required
passwordClearText	string	User's password in a clear text; used only to set initial password	optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{
  "email": "string",
  "firstName": "string",
  "groups": [
    "string"
  ],
  "id": "string",
  "lastName": "string",
  "passwordClearText": "string"
}

Response

Response codes

Code	Type	Description
200	UserConfig	Successfully created
400		Operation failed. The input is invalid. Possible reasons: all required values (ID, email, first name, last name) must be set invalid user data user ID already exists user email address already assigned user group ID does not exist
403		Operation forbidden - users and groups are fully managed via LDAP or SSO
406		Unacceptable request
522		Couldn't create user
523		User already exists
524		Email address already registered

Response body objects

The `UserConfig` object

The configuration of the user.

Element	Type	Description
email	string	User's email address
firstName	string	User's first name
groups	string[]	List of user's user group IDs.
id	string	User ID
lastName	string	User's last name
passwordClearText	string	User's password in a clear text; used only to set initial password

Response body JSON model

json
{
  "email": "string",
  "firstName": "string",
  "groups": [
    "string"
  ],
  "id": "string",
  "lastName": "string",
  "passwordClearText": "string"
}

Example

In this example, you add john.wicked user and assign admins group. As a response, you will receive back persisted state of the entity.

Curl

bash
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/users" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"id\":\"john.wicked\",\"email\":\"john.wicked@company.com\",\"firstName\":\"John\",\"lastName\":\"Wicked\",\"passwordClearText\":null,\"groups\":[\"admin\"]}"

Request URL

plaintext
https://myManaged.cluster.com/api/v1.0/onpremise/users

Response body

json
{
    "id": "john.wicked",
    "email": "john.wicked@company.com",
    "firstName": "John",
    "lastName": "Wicked",
    "passwordClearText": null,
    "groups": [
      "admin"
    ]
  }

Response code

200

Create user

Authentication

Endpoint

Parameter

Request body objects

The UserConfig object

Request body JSON model

Response

Response codes

Response body objects

The UserConfig object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `UserConfig` object

The `UserConfig` object