Common response parameters

Edit online

Table 1. Response Parameters
Response Parameter	Style	Type	Description
credential	body	Object	A credential object
blob	body	String	The credential itself, as a serialized blob Required: Yes
project_id	body	String	The storage account ID Required: Yes
type	body	String	Required: Yes (ec2)
subject_ibm_id	body	String	Identity of the user/service within IAM. Required: No. Only present if subject_ibm_id was configured for this access key
id	body	String	The Access Key Required: Yes, only if being requested on behalf of another user

Table 2. HTTP Response Code
HTTP Response Code	Description
200 OK	Success request
400 Bad Request	Request does not comply with specification
401 Unauthorized	The provided token is not valid or cannot be verified
403 Forbidden	The provided token although valid, does not provide appropriate permissions to the user
404 Not Found	No such user or storage account exists
405 Method Not Allowed	Although the user may be valid, the user does not have privileges to access storage account
503 Service Unavailable	The credential API service is currently unavailable

Table 3. Role Guidance
Role Guidance	Description
Key Management Permission	Generic permission to allow a user to manage access keys

Example Output


Request
-------
PATCH <accesser>:8338/credentials/181920
Content-Length: 263
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
X-Timestamp: 1458262564.22774
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a
{
    "credential": {
        "blob": {"access": "181920",
                 "secret": "secretKey",
                 "status": "Inactive"
        },
        "project_id": "731fc6f265cd486d900f16e84c5cb594",
        "type": "ec2",
        "user_id": "bb5476fd12884539b41d5a88f838d773"
    }
}

Response
--------
HTTP/1.1 200 OK
Content-Length: 341
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
X-Timestamp: 1458262564.22774
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a
{
    "credential": {
        "user_id": "bb5476fd12884539b41d5a88f838d773",
        "blob": {"access": "a42a27755ce6442596b049bd7dd8a563",
                 "secrete": "secretKey",
                 "status": "Inactive"
        },
        "project_id": "731fc6f265cd486d900f16e84c5cb594",
        "type": "ec2",
        "subject_ibm_id": "IBMid-61KR43CAFF",
        "id": "a42a27755ce6442596b049bd7dd8a563"
    }
}