- API >
- Public API Resources >
- Projects and Users >
- Users >
- Create the First User
Create the First User¶
On this page
Create the first Ops Manager user. This endpoint is the only API call you can make without first having an API key.
Exceptions
- This endpoint cannot be used if Ops Manager uses LDAP for authentication.
- This endpoint can create the first user only if Ops Manager runs in
Invitation Only Mode
.
The user created through this endpoint is automatically granted the GLOBAL_OWNER role. The returned document includes the new user’s Public API key and and other details, which you can use to make further API calls.
The endpoint does not create a project, but you can use the new user and API key to create a project through the Projects resource in the API. You cannot login to Ops Manager until after you have created a project.
You can use this endpoint to create additional users. Users created after the first are not granted the GLOBAL_OWNER role automatically.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
Name | Type | Description |
---|---|---|
whitelist | string | The IP address that you want to add to the new user’s whitelist. Note You can add more than one whitelist parameter and value. |
Request Body Parameters¶
Name | Type | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
username | string | Username of the Ops Manager user. Validated depending on the
value of the
See Note The |
||||||||
password | string | Password of the new Ops Manager user. This field is not included in the HTTP response body. It can only be sent in the HTTP request when creating a new user. | ||||||||
emailAddress | string | (Optional.) Email address of the new Ops Manager user. | ||||||||
firstName | string | First name of the new Ops Manager user. | ||||||||
lastName | string | Last name of the new Ops Manager user. |
Response¶
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
user | object | Details of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
user.emailAddress | string | Email address of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
user.firstName | string | First name of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
user.id | string | Unique identifier of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
user.lastName | string | Last name of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
user.links | object array | Links to related sub-resources. All links arrays in
responses include at least one link called self. The
relationships between URLs are explained in the
Web Linking Specification. |
||||||||||||||||||||||||||||||||||||||||
user.mobileNumber | string | Mobile number of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
user.roles | object array | Role assignments. | ||||||||||||||||||||||||||||||||||||||||
user.roles.groupId | string | Unique identifier for the project in which the user has the specified role. For the “global” roles (those whose name starts
with |
||||||||||||||||||||||||||||||||||||||||
user.roles.orgId | string | Unique identifier for the organization in which the user has the specified role. | ||||||||||||||||||||||||||||||||||||||||
user.roles.roleName | string | Name of the role. Values are:
|
||||||||||||||||||||||||||||||||||||||||
user.username | string | Username of the Ops Manager user. |