This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Create an access key

1: 1.2
2: 1.1
3: 1.0

1 - 1.2

post /v1/access-keys

Description

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		AccessKeyCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccessKeyResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.2"

Request body

{
    "access_key_type": "PERMANENT",
    "account_id": "f39c460fade34fecb05ede8f904b24b7",
    "description": "description",
    "duration": "P1Y2M10DT2H30M15S",
    "parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
    "passcode": "000000"
}

Example HTTP response

Response 201

{
    "access_key": {
        "access_key": "b754b12b39da4ce29a40c5e324650bd0",
        "access_key_type": "PERMANENT",
        "account_id": "f39c460fade34fecb05ede8f904b24b7",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "description",
        "expiration_timestamp": "9999-12-31T23:59:59Z",
        "id": "6558fc9df5b54c8a985465bdf637e097",
        "is_enabled": "true",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
        "secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
    }
}

2 - 1.1

post /v1/access-keys

Description

Create an access key

State ACTIVE (SUPPORTED)

Version	Supported Until
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		AccessKeyCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccessKeyResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.1"

Request body

{
    "access_key_type": "PERMANENT",
    "account_id": "f39c460fade34fecb05ede8f904b24b7",
    "description": "description",
    "duration": "P1Y2M10DT2H30M15S",
    "parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
    "passcode": "000000"
}

Example HTTP response

Response 201

{
    "access_key": {
        "access_key": "b754b12b39da4ce29a40c5e324650bd0",
        "access_key_type": "PERMANENT",
        "account_id": "f39c460fade34fecb05ede8f904b24b7",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "description",
        "expiration_timestamp": "9999-12-31T23:59:59Z",
        "id": "6558fc9df5b54c8a985465bdf637e097",
        "is_enabled": "true",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
        "secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
    }
}

3 - 1.0

post /v1/access-keys

Description

Create an access key

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260223

Parameters

Type	Name	Description	Schema	Default
body	body required		AccessKeyCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccessKeyResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.0"

Request body

{
    "access_key_type": "PERMANENT",
    "account_id": "f39c460fade34fecb05ede8f904b24b7",
    "description": "description",
    "duration": "P1Y2M10DT2H30M15S",
    "parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
    "passcode": "000000"
}

Example HTTP response

Response 201

{
    "access_key": {
        "access_key": "b754b12b39da4ce29a40c5e324650bd0",
        "access_key_type": "PERMANENT",
        "account_id": "f39c460fade34fecb05ede8f904b24b7",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "description",
        "expiration_timestamp": "9999-12-31T23:59:59Z",
        "id": "6558fc9df5b54c8a985465bdf637e097",
        "is_enabled": "true",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
        "secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
    }
}