Skip to content
/users

Object Storage REST APIs. (1.0.0)

Object Storage REST APIs.

Download OpenAPI description
object-storage-api.json
object-storage-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://eu1.data.cloud.hpe.com/

https://us1.data.cloud.hpe.com/

https://jp1.data.cloud.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/object-storage/public/openapi/object-storage-public-v1alpha1/object-storage-api/

access-policies

The Access Policies API provides endpoints for creating, managing, and configuring access policies.

Operations

buckets

The Buckets API provides endpoints for creating, managing, and configuring storage buckets. Buckets are containers for organizing and storing data, and this API allows full control over their lifecycle, including creation, updates, retrieval, and deletion.

Operations

groups

The Groups API provides endpoints for creating, managing, and configuring groups.

Operations

users

The Users API provides endpoints for creating, managing, and configuring users.

Operations

Get the properties of existing users in ObjectStore

Request

Get users properties in ObjectStore identified by {systemId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Query
filterstring

oData query to filter bucket by Key.

Example: filter=id eq "abc"
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
selectstring

A query to retrieve only the specified parameters. Use . to denote nested fields.

Example: select=id
sortstring

A list of properties defining the sort order. This takes a single property name followed by the direction to sort in, separated by a space. The supported properties are systemUid, id and generation. If not specified, the default behaviour is to sort by generation. The supported directions are asc and desc for ascending and descending respectively.

Default "generation desc"
Example: sort=id desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(UserListDetails)required
items[].​idstringrequired
items[].​typestringrequired
items[].​commonResourceAttributesobject or null(CommonResourceAttributes)
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
items[].​generationinteger or null(Uint64)
items[].​memberOfArray of strings or null
items[].​namestring
Example: "NewUser1"
items[].​policyNamestring
items[].​systemUidstring
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Create new user in HPE Alletra Storage MP X10000 device

Request

Create new user in HPE Alletra Storage MP X10000 device identified by {systemId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Bodyapplication/json
namestringrequired
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Created

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
secretKeystring
Response
application/json
{
  "secretKey": "string"
}

Delete user from HPE Alletra Storage MP X10000 ObjectStore

Request

Delete user from HPE Alletra Storage MP X10000 ObjectStore identified by {bucketId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
userIdstringrequired

A unique identifier assigned to each user created in the ObjectStore

Example: testUser
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/users/testUser \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the properties of an existing user in ObjectStore

Request

Get user properties in ObjectStore identified by {systemId} and {userId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
userIdstringrequired

A unique identifier assigned to each user created in the ObjectStore

Example: testUser
Query
selectstring

A query to retrieve only the specified parameters. Use . to denote nested fields.

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/users/testUser \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired
typestringrequired
commonResourceAttributesobject or null(CommonResourceAttributes)
customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
generationinteger or null(Uint64)
memberOfArray of strings or null
namestring
Example: "NewUser1"
policyNamestring
systemUidstring
Response
application/json
{
  "commonResourceAttributes": {
    "cloudState": "CONNECTED",
    "errCode": "E01",
    "errMessage": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests."
  },
  "customerId": "fc5f41652a53497e88cdcebc715cc1sd",
  "generation": 0,
  "id": "string",
  "memberOf": [
    "string"
  ],
  "name": "NewUser1",
  "policyName": "string",
  "systemUid": "string",
  "type": "string"
}

Edit the properties of an existing user in HPE Alletra Storage MP X10000 ObjectStore

Request

Edit user properties in HPE Alletra Storage MP X10000 ObjectStore identified by {systemId} and {userId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
userIdstringrequired

A unique identifier assigned to each user created in the ObjectStore

Example: testUser
Bodyapplication/jsonrequired
resetPasswordbooleanrequired
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/users/testUser \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resetPassword": true
  }'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}