Create Credential
Operation ID: createCredential
Create S3 credential for the platform user
Request
URI
POST
https://{api_host}/api/v1/tenants/{tenantId}/users/{userId}/s3credentials
COPY
Path Parameters
string
tenantId
Required
The ID of the tenant which the user belongs to
string
userId
Required
The ID of the user which the created S3 credential belongs to
Responses
201
S3 credential is created for the user
Returns OsisS3Credential of type(s) application/json
{
"tenant_id": "acme",
"secret_key": "yz8PIwNjmm2zlHX8m7st6BSKh8PCe7bqAaRGkF5K",
"user_id": "961515dd-8348-4cac-8780-5edcb8a87b58",
"access_key": "00e4a3d674aada749f04",
"cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f",
"active": true,
"creation_date": "2000-01-23T04:56:07+00:00",
"cd_user_id": "2b4d76d7-89fa-45fb-ab3e-3fa3bb268335",
"username": "rachelw"
}string
access_key
Required
The S3 access key.
string
secret_key
Required
The S3 secret key.
boolean
active
Optional
The status of platform S3 key. For the platforms not supporting activate/deactivate S3 key, either returning active=true or not returning active indicates the platform S3 key is in active status.
string As date-time As date-time
creation_date
Optional
S3 credential creation date.
string
tenant_id
Required
The ID of the tenant which the S3 credential belongs to.
string
user_id
Required
The ID of the user which the S3 credential belongs to.
string
username
Optional
The name of the platform user which the S3 credential belongs to.
string
cd_user_id
Required
The ID of VCD user.
string
cd_tenant_id
Required
The ID of VCD 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