Skip to content
Console(the OVHcloud Console, opens in a new tab)

Users

All operations require authentication.

8 operationsv2/publicCloud/project
OpenAPI
Agent setup

List usersBeta

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user

Returns the users of the service with their ACL entries and status. Passwords are not returned.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200User[]successful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "acls": [      {        "pattern": "string",        "permission": "ADMIN"      }    ],    "admin": true,    "checksum": "string",    "createdAt": "2024-01-01T12:00:00Z",    "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",    "id": "00000000-0000-0000-0000-000000000000",    "password": "string",    "status": "CREATING",    "username": "string"  }]

Get a userBeta

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId}

Returns the user, its ACL entries and its status. The password is not returned.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

userId
required
stringuuid

User ID

Response

200Usersuccessful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "acls": [    {      "pattern": "string",      "permission": "ADMIN"    }  ],  "admin": true,  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",  "id": "00000000-0000-0000-0000-000000000000",  "password": "string",  "status": "CREATING",  "username": "string"}

Create a userBeta

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user

Creates a user with ACL entries, each granting a permission on an index pattern. The generated password is returned only on creation and on password reset.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Request body (required)

acls
UserAcl[]

ACL entries to grant to the user

name
required
string

Login name of the new user

Response

200Usersuccessful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "acls": [    {      "pattern": "string",      "permission": "ADMIN"    }  ],  "admin": true,  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",  "id": "00000000-0000-0000-0000-000000000000",  "password": "string",  "status": "CREATING",  "username": "string"}

Delete a userBeta

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId}

Permanently deletes the user.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

userId
required
stringuuid

User ID

Response

200Usersuccessful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "acls": [    {      "pattern": "string",      "permission": "ADMIN"    }  ],  "admin": true,  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",  "id": "00000000-0000-0000-0000-000000000000",  "password": "string",  "status": "CREATING",  "username": "string"}

Update a userBeta

PUT
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId}

Updates the ACL entries of the user. The ACL list replaces the current entries. To reset the password, use the resetPassword route of the user or a partial update with credentialsLastUpdatedAt.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

userId
required
stringuuid

User ID

Request body (required)

acls
required
UserAcl[]

ACL entries for the user

Response

200Usersuccessful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "acls": [    {      "pattern": "string",      "permission": "ADMIN"    }  ],  "admin": true,  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",  "id": "00000000-0000-0000-0000-000000000000",  "password": "string",  "status": "CREATING",  "username": "string"}

Partially update a userBeta

PATCH
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId}

Partially updates the ACL entries of the user. The ACL list replaces the current entries. Setting credentialsLastUpdatedAt resets the password and returns the new one.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

userId
required
stringuuid

User ID

Request body (required)

acls
UserAcl[]

ACL entries for the user

credentialsLastUpdatedAt
stringdate-time

Date at which the user credentials were last updated. Setting this field triggers a credential reset and returns the new password.

Response

200Usersuccessful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "acls": [    {      "pattern": "string",      "permission": "ADMIN"    }  ],  "admin": true,  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",  "id": "00000000-0000-0000-0000-000000000000",  "password": "string",  "status": "CREATING",  "username": "string"}

List user permissionsBeta

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/permissions

Returns the permissions that can be granted to users on an index pattern.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200string[]successful operation

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/permissions \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

Reset the password of a userBeta

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId}/resetPassword

Generates a new password for the user and returns it in the response. Reading the user never returns it. The previous password stops working once the new one is applied, and credentialsLastUpdatedAt becomes the date of this reset. This is the same reset as a partial update of the user that sets credentialsLastUpdatedAt.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

userId
required
stringuuid

User ID

Response

200Usersuccessful operation
acls
read-only
UserAcl[]

ACL entries granted to the user

admin
read-only
boolean

Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted

checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the user was created

credentialsLastUpdatedAt
read-only
stringdate-time

Date at which the user credentials were last updated

id
read-only
stringuuid

Unique identifier of the user

password
read-only
stringpassword

Password of the user. Returned only on creation or password reset.

status
read-only
UserStatusEnum

Current readiness status of the user

ValuesCREATINGDELETINGERRORREADYUPDATING
username
read-only
string

Login name of the user

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/user/{userId}/resetPassword \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "acls": [    {      "pattern": "string",      "permission": "ADMIN"    }  ],  "admin": true,  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z",  "id": "00000000-0000-0000-0000-000000000000",  "password": "string",  "status": "CREATING",  "username": "string"}