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

Return to the regular view of this page.

Set an access key

1: 1.4
2: 1.3
3: 1.2
4: 1.1
5: 1.0

1 - 1.4

put /v1/access-keys/{access_key_id}

Description

Set or update an access key

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	access_key_id required	Access Key ID Example : `f39c460fade34fecb05ede8f904b24b7`	string	None
body	body required		AccessKeyUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessKeyResponse
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys/{access_key_id}

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.4"

Request body

{
    "is_enabled": "true"
}

Example HTTP response

Response 200

{
    "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.3

put /v1/access-keys/{access_key_id}

Description

Set or update an access key

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	access_key_id required	Access Key ID Example : `f39c460fade34fecb05ede8f904b24b7`	string	None
body	body required		AccessKeyUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessKeyResponse
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys/{access_key_id}

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.3"

Request body

{
    "is_enabled": "true"
}

Example HTTP response

Response 200

{
    "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.2

put /v1/access-keys/{access_key_id}

Description

Set or update an access key

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	access_key_id required	Access Key ID Example : `f39c460fade34fecb05ede8f904b24b7`	string	None
body	body required		AccessKeyUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessKeyResponse
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys/{access_key_id}

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

{
    "is_enabled": "true"
}

Example HTTP response

Response 200

{
    "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"
    }
}

4 - 1.1

put /v1/access-keys/{access_key_id}

Description

Set or update an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
path	access_key_id required	Access Key ID Example : `f39c460fade34fecb05ede8f904b24b7`	string	None
body	body required		AccessKeyUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessKeyResponse
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys/{access_key_id}

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

{
    "is_enabled": "true"
}

Example HTTP response

Response 200

{
    "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"
    }
}

5 - 1.0

put /v1/access-keys/{access_key_id}

Description

Set or update an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260223

Parameters

Type	Name	Description	Schema	Default
path	access_key_id required	Access Key ID Example : `f39c460fade34fecb05ede8f904b24b7`	string	None
body	body required		AccessKeyUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessKeyResponse
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-keys/{access_key_id}

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

{
    "is_enabled": "true"
}

Example HTTP response

Response 200

{
    "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"
    }
}