Skip to content
Internal API Catalog
/
Data Services API
/
secret-assignments

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

Reports filtered assignments

Request

Reports the attributes of the assignments owned by the customer. The response can be paged by using the limit and offset query parameters and filtered and sorted by using the filter and sort query parameters.

Query
filterstring(Filter)

An OData expression to filter responses by attribute. The OData logical operator "eq" is case-sensitive and supported for attributes "applianceId", "secretId", "goal", "service", or "status". The OData function "contains()" is not case-sensitive and supported for attribute "applianceId", "secretId", and "service". The OData logical operator "and" is supported for all attributes.

sortstring(Sort)

A response attribute to sort by, followed by a direction indicator ("asc" or "desc"). The attribute may be one of "applianceId", "secretId", "createdAt", "goal", "id", "label", "service", "status" or "updatedAt". Default: ascending.

offsetinteger(Offset)

The offset query parameter should be used in conjunction with limit for paging within a batched result set. The offset is the number of items from the beginning of the batched result set to the first item included in the response. Example: offset=30&limit=10

Default 0
limitinteger(Limit)<= 120

The limit query parameter should be used in conjunction with offset for paging within a batched result set. The limit is the maximum number of items to include in the response. Example: offset=30&limit=10

Default 20
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secret-assignments

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required

Current results page count

itemsArray of objects(Items)required

Assignment resource definitions

items[].​customerIdstring(Customerid)required

Identifier of the customer owning the resource

items[].​servicestring(Service)required

Name of the service originating the resource

items[].​idstring(uuid)(Id)required

Identifier of the resource

items[].​namestring(Name)required

Name of the resource

items[].​typestring(Type)required

Type of the resource

items[].​resourceUristring(Resourceuri)required

URI of the resource

items[].​generationinteger(Generation)required

Update generation number

items[].​updatedAtstring(date-time)(Updatedat)required

Timestamp of the last resource update

items[].​createdAtstring(date-time)(Createdat)required

Timestamp of the resource creation

items[].​statusstring(Status)required

Current status of the assignment

items[].​statusUpdatedAtstring(date-time)(Statusupdatedat)required

Timestamp of the last status update

items[].​goalstring(Goal)required

Current goal of the assignment

items[].​goalUpdatedAtstring(date-time)(Goalupdatedat)required

Timestamp of the last goal update

items[].​secretobject(Secret)required

Secret resource reference

items[].​secret.​idstring(uuid)(Id)required

Identifier of the resource

items[].​secret.​namestring(Name)required

Name of the resource

items[].​secret.​typestring(Type)required

Type of the resource

items[].​secret.​resourceUristring(Resourceuri)required

URI of the resource

items[].​applianceobject(Appliance)required

Appliance identifier

items[].​appliance.​idstring(Id)required

Identity of the appliance

items[].​groupsArray of objects(Groups)

Groups associated with the resource

items[].​labelstring(Label)

Consumer-defined label of the assignment

nextstring(Next)

Cursor for next results page

offsetinteger(Offset)

Offset of current results page

totalinteger(Total)

Total results count

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

Reports a specific assignment

Request

Reports the attributes of the specified assignment.

Path
idstring(uuid)(Id)required

UUID of the secret

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secret-assignments/{id}'

Responses

Successful Response

Bodyapplication/json
customerIdstring(Customerid)required

Identifier of the customer owning the resource

servicestring(Service)required

Name of the service originating the resource

idstring(uuid)(Id)required

Identifier of the resource

namestring(Name)required

Name of the resource

typestring(Type)required

Type of the resource

resourceUristring(Resourceuri)required

URI of the resource

generationinteger(Generation)required

Update generation number

updatedAtstring(date-time)(Updatedat)required

Timestamp of the last resource update

createdAtstring(date-time)(Createdat)required

Timestamp of the resource creation

statusstring(Status)required

Current status of the assignment

statusUpdatedAtstring(date-time)(Statusupdatedat)required

Timestamp of the last status update

goalstring(Goal)required

Current goal of the assignment

goalUpdatedAtstring(date-time)(Goalupdatedat)required

Timestamp of the last goal update

secretobject(Secret)required

Secret resource reference

secret.​idstring(uuid)(Id)required

Identifier of the resource

secret.​namestring(Name)required

Name of the resource

secret.​typestring(Type)required

Type of the resource

secret.​resourceUristring(Resourceuri)required

URI of the resource

applianceobject(Appliance)required

Appliance identifier

appliance.​idstring(Id)required

Identity of the appliance

groupsArray of objects(Groups)

Groups associated with the resource

labelstring(Label)

Consumer-defined label of the assignment

Response
application/json
{
  "appliance": {
    "id": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "goal": "string",
  "goalUpdatedAt": "2019-08-24T14:15:22Z",
  "groups": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "name": "string",
  "resourceUri": "string",
  "secret": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "resourceUri": "string",
    "type": "string"
  },
  "service": "string",
  "status": "string",
  "statusUpdatedAt": "2019-08-24T14:15:22Z",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations