Update Credential Status

Update Credential Status

Operation ID: updateCredentialStatus
Enabled or disable AWS Signature V4 key-pair credential for the storage user. Parameters tenant_id and tenant_id are always in request; the platform decides whehter to use them.

Request
URI
PATCH
https://{api_host}/osis/api/v1/s3credentials/{accessKey}
COPY
Path Parameters
string
accessKey
Required

The access key of the AWS Signature V4 key-pair credential to update status

Query Parameters
string
tenant_id
Optional

The ID of the storage tenant to which the user belongs

string
user_id
Optional

The ID of the storage user to which the status updating AWS Signature V4 key-pair credential belongs


Request Body

The AWS Signature V4 key-pair credential containing the status to update. Only property 'active' takes effect

OsisS3Credential of type(s) application/json
Required
{
    "access_key": "00e4a3d674aada749f04",
    "secret_key": "yz8PIwNjmm2zlHX8m7st6BSKh8PCe7bqAaRGkF5K",
    "active": true,
    "creation_date": "string",
    "tenant_id": "acme",
    "user_id": "961515dd-8348-4cac-8780-5edcb8a87b58",
    "username": "rachelw",
    "cd_user_id": "2b4d76d7-89fa-45fb-ab3e-3fa3bb268335",
    "cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f"
}
string
access_key
Required

AWS Signature V4 access key

string
secret_key
Required

AWS Signature V4 secret key

boolean
active
Optional

AWS Signature V4 key-pair credential status

string As date-time As date-time
creation_date
Optional

AWS Signature V4 key-pair credential creation date

string
tenant_id
Optional

The ID of the storage tenant which the AWS Signature V4 key-pair credential belongs to

string
user_id
Optional

The ID of the storage user which the AWS Signature V4 key-pair credential belongs to

string
username
Optional

The name of the user which the AWS Signature V4 key-pair credential belongs to

string
cd_user_id
Optional

Cloud Director user id

string
cd_tenant_id
Optional

id of Cloud Director tenant which the user belongs to

Authentication
This operation uses the following authentication methods.
Responses
200

The status of the AWS Signature V4 key-pair credential is updated

Returns OsisS3Credential of type(s) application/json
{
    "access_key": "00e4a3d674aada749f04",
    "secret_key": "yz8PIwNjmm2zlHX8m7st6BSKh8PCe7bqAaRGkF5K",
    "active": true,
    "creation_date": "string",
    "tenant_id": "acme",
    "user_id": "961515dd-8348-4cac-8780-5edcb8a87b58",
    "username": "rachelw",
    "cd_user_id": "2b4d76d7-89fa-45fb-ab3e-3fa3bb268335",
    "cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f"
}
string
access_key
Required

AWS Signature V4 access key

string
secret_key
Required

AWS Signature V4 secret key

boolean
active
Optional

AWS Signature V4 key-pair credential status

string As date-time As date-time
creation_date
Optional

AWS Signature V4 key-pair credential creation date

string
tenant_id
Optional

The ID of the storage tenant which the AWS Signature V4 key-pair credential belongs to

string
user_id
Optional

The ID of the storage user which the AWS Signature V4 key-pair credential belongs to

string
username
Optional

The name of the user which the AWS Signature V4 key-pair credential belongs to

string
cd_user_id
Optional

Cloud Director user id

string
cd_tenant_id
Optional

id of Cloud Director tenant which the user belongs to


400

Bad Request

Returns OsisError of type(s) application/json
{
    "code": "E_BAD_REQUEST",
    "message": "invalid value for the property xyz."
}
string
code
Required

code

string
message
Optional

message


501

The optional API is not implemented

Operation doesn't return any data structure