Common response parameters

Edit online

Table 1. Common response parameters
Response Parameter	Style	Type	Description
credentials	body	List	A credential object list
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	This will be the Access Key Required: Yes

Table 2. HTTP response codes
HTTP Response Code	Description
200 OK	The specified user or storage account exists.
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	The specified user or storage account does not exist.
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 Listing Admin Permission	Generic permission to allow an admin to list access keys
Key Listing User Permission	Generic permission to allow a user to list access keys

Example Output


Request
-------
GET <accesser>:8338/credentials/?project_id=6e01855f345f4c59812999b5e459137d

Response
--------
HTTP/1.1 200 OK
Content-Length: 786
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
X-Timestamp: 1458262564.22774
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a
Date: Fri, 18 Mar 2016 00:56:10 GMT
{
    "credentials": [
        {
            "user_id": "bb5476fd12884539b41d5a88f838d773",
            "blob": {"access": "a42a27755ce6442596b049bd7dd8a563", 
                     "secret": "71faf1d40bb24c82b479b1c6fbbd9f0c", 
                     "status": "Active"
            },
            "project_id": "6e01855f345f4c59812999b5e459137d",
            "type": "ec2",
            "subject_ibm_id": "IBMid-61KR43CAFF",
            "id": "a42a27755ce6442596b049bd7dd8a563"
        },
        {
            "user_id": "6f556708d04b4ea6bc72d7df2296b71a",
            "blob": {"access": "7da79ff0aa364e1396f067e352b9b79a", 
                     "secret": "7a18d68ba8834b799d396f3ff6f1e98c", 
                     "status": "Active"
            },
            "project_id": "1a1d14690f3c4ec5bf5f321c5fde3c16",
            "type": "ec2",
            "id": "7da79ff0aa364e1396f067e352b9b79a"
        }
    ]
}