dual-auth-operations

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

List Dual Authorization operations

Request

Returns the list of Dual Authorization operations for the current account. The list will include only the resource types (Application Resource) the user has read permission for. The user must have permission to read pending operations.

Security

bearer

Query

offsetinteger

Use offset in conjunction with limit for paging. The offset is the number of items from the beginning of the result set to the first item included in the response.

limitinteger[ 1 .. 100 ]

Use limit in conjunction with offset for paging. The limit is the maximum number of items to include in the response.

Default 10

filterstring

The expression to use for filtering responses. The following comparisons are supported: “eq” : Valid for number, boolean and string properties. “gt” : Valid for number or string timestamp properties. “lt” : Valid for number or string timestamp properties “in” : Valid for an array of strings Syntax: “eq” : filter=<property> eq <value> {host:port}/data-services/v1beta1/dual-auth-operations?filter=<property> eq <value> “gt” : filter=<property> gt <value> {host:port}/data-services/v1beta1/dual-auth-operations?filter=<property> gt <value> “lt” : filter=<property> lt <value> {host:port}/data-services/v1beta1/dual-auth-operations?filter=<property> lt <value> “in” : filter=<property> in <value> {host:port}/data-services/v1beta1/dual-auth-operations?filter=<property> in <value>

Use "and" to combine filter inputs {host:port}/data-services/v1beta1/dual-auth-operations?filter=<property1> eq <value1> and <property2> lt <value2>
To filter multiple values on one property e.g. filter=resourceType in ('foo','bar') {host:port}/data-services/v1beta1/dual-auth-operations?filter=foo%bar%20in%20resourceType Examples: GET /data-services/v1beta1/dual-auth-operations?filter=resourceType eq 'ISSUE' GET /data-services/v1beta1/dual-auth-operations?filter=resourceType eq 'ISSUE' and state eq 'CREATED' GET /data-services/v1beta1/dual-auth-operations?filter=relatedObjectType in ('NIMBLE-VOLUME') Filters are supported on following attributes: resourceUri, resourceName, resourceType, requestedOperation, operationDescription, requestedByUri, requestedByEmail, requestedAt, customerId, checkedByUri, checkedByEmail, checkedAt, sourceServiceExternalName, state

sortstring

The property to sort by followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending.

selectstring

Limits the properties returned with a resource or collection-level GET. Specify a comma-separated list of properties. If this is omitted, all properties are returned.

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-api/data-services/v1beta1/dual-auth-operations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Dual Authorization Operation List

Bodyapplication/json

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(Dual-Auth-Operation)required

items[].idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].typestringread-onlyrequired

The type of resource.

items[].generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].createdAtstring(date-time)required

items[].updatedAtstring(date-time)required

items[].resourceUristringread-onlyrequired

The self reference for this resource.

items[].customerIdstringread-onlyrequired

The customer application identifier

items[].namestring

A system specified name for the resource.

items[].associatedResourcesArray of objects(AssociatedResource)

Resources associated with this operation

items[].checkedAtstring(date-time)

Time when this operation was checked. RFC 3339 Timestamp

items[].checkedByEmailstring

Email of the user who checked (second authorization) this operation

items[].checkedByUristring

URI of the user who checked (second authorization) this operation

items[].descriptionstring

Detailed description of the operation

items[].requestedAtstring(date-time)

Time when this operation was requested. RFC 3339 Timestamp

items[].requestedByEmailstring

Email of the user who performed this operation

items[].requestedByUristring

URI of the user who performed this operation

items[].requestedOperationstring

One word description of the operation

items[].sourceServiceExternalNamestring

External Service Name from where this request was sent

items[].statestring

state of this operation

items[].consoleUristringDeprecated

The URI for console screen that displays this resource. Deprecated - use associatedResources instead

items[].groupsArray of objects(GroupIDNamePair)Deprecated

Groups this operation is associated with. Deprecated - use associatedResources instead

items[].operationResourceobjectDeprecated

Operation resource on which the operation is taking place. Deprecated - use associatedResources instead

totalinteger

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

Response

application/json

{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Get Dual Authorization operation by Id

Request

Returns the Dual Authorization operation for the given Id. The operation must belong to the current account and be a resource type the user has read permission for. The user must also have permission to read pending operations.

Security

bearer

Path

idstring(uuid)required

the ID of the operation

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3

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-api/data-services/v1beta1/dual-auth-operations/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Dual Authorization details on an operation

Bodyapplication/json

idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required

updatedAtstring(date-time)required

resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

associatedResourcesArray of objects(AssociatedResource)

Resources associated with this operation

checkedAtstring(date-time)

Time when this operation was checked. RFC 3339 Timestamp

checkedByEmailstring

Email of the user who checked (second authorization) this operation

checkedByUristring

URI of the user who checked (second authorization) this operation

descriptionstring

Detailed description of the operation

requestedAtstring(date-time)

Time when this operation was requested. RFC 3339 Timestamp

requestedByEmailstring

Email of the user who performed this operation

requestedByUristring

URI of the user who performed this operation

requestedOperationstring

One word description of the operation

sourceServiceExternalNamestring

External Service Name from where this request was sent

statestring

state of this operation

consoleUristringDeprecated

The URI for console screen that displays this resource. Deprecated - use associatedResources instead

groupsArray of objects(GroupIDNamePair)Deprecated

Groups this operation is associated with. Deprecated - use associatedResources instead

operationResourceobjectDeprecated

Operation resource on which the operation is taking place. Deprecated - use associatedResources instead

Response

application/json

{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "associatedResources": [
    { … }
  ],
  "checkedAt": "2019-08-24T14:15:22Z",
  "checkedByEmail": "string",
  "checkedByUri": "string",
  "consoleUri": "string",
  "description": "string",
  "groups": [
    { … }
  ],
  "operationResource": {
    "name": "string",
    "resourceUri": "string",
    "type": "string"
  },
  "requestedAt": "2019-08-24T14:15:22Z",
  "requestedByEmail": "string",
  "requestedByUri": "string",
  "requestedOperation": "string",
  "sourceServiceExternalName": "string",
  "state": "string"
}

Changes the value of the given Dual Authorization operation. Approve/Deny the pending operation by changing its state in DB

Request

Approve/Deny the pending operation by changing its state in DB.

Security

bearer

Path

idstring(uuid)required

the ID of the operation

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3

Bodyapplication/merge-patch+jsonrequired

statestringrequired

new value of the "state" setting

Enum"APPROVED""CANCELLED"

curl -i -X PATCH \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/dual-auth-operations/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "state": "APPROVED"
  }'

Responses

Dual Authorization Detail

Bodyapplication/json

idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required

updatedAtstring(date-time)required

resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

associatedResourcesArray of objects(AssociatedResource)

Resources associated with this operation

checkedAtstring(date-time)

Time when this operation was checked. RFC 3339 Timestamp

checkedByEmailstring

Email of the user who checked (second authorization) this operation

checkedByUristring

URI of the user who checked (second authorization) this operation

descriptionstring

Detailed description of the operation

requestedAtstring(date-time)

Time when this operation was requested. RFC 3339 Timestamp

requestedByEmailstring

Email of the user who performed this operation

requestedByUristring

URI of the user who performed this operation

requestedOperationstring

One word description of the operation

sourceServiceExternalNamestring

External Service Name from where this request was sent

statestring

state of this operation

consoleUristringDeprecated

The URI for console screen that displays this resource. Deprecated - use associatedResources instead

groupsArray of objects(GroupIDNamePair)Deprecated

Groups this operation is associated with. Deprecated - use associatedResources instead

operationResourceobjectDeprecated

Operation resource on which the operation is taking place. Deprecated - use associatedResources instead

Response

application/json

{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "associatedResources": [
    { … }
  ],
  "checkedAt": "2019-08-24T14:15:22Z",
  "checkedByEmail": "string",
  "checkedByUri": "string",
  "consoleUri": "string",
  "description": "string",
  "groups": [
    { … }
  ],
  "operationResource": {
    "name": "string",
    "resourceUri": "string",
    "type": "string"
  },
  "requestedAt": "2019-08-24T14:15:22Z",
  "requestedByEmail": "string",
  "requestedByUri": "string",
  "requestedOperation": "string",
  "sourceServiceExternalName": "string",
  "state": "string"
}

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

Data Services API (1.3.0)

async-operations