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

Return to the regular view of this page.

List Users

1 - 1.3

get /v1/kms/transit/{key_id}/users

Description

Get List of users who use key.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathkey_id
required
Resource id of KMS key
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKKeyUserResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kms/transit/{key_id}/users

Request header

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

Example HTTP response

Response 200

{
    "user": [
        {
            "user_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "user_name": "kimsamsung"
        }
    ]
}

2 - 1.2

get /v1/kms/transit/{key_id}/users

Description

Get List of users who use key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

TypeNameDescriptionSchemaDefault
pathkey_id
required
Resource id of KMS key
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKKeyUserResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kms/transit/{key_id}/users

Request header

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

Example HTTP response

Response 200

{
    "user": [
        {
            "user_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "user_name": "kimsamsung"
        }
    ]
}

3 - 1.1

get /v1/kms/transit/{key_id}/users

Description

Get List of users who use key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

TypeNameDescriptionSchemaDefault
pathkey_id
required
Resource id of KMS key
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKKeyUserResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kms/transit/{key_id}/users

Request header

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

Example HTTP response

Response 200

{
    "user": [
        {
            "user_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "user_name": "kimsamsung"
        }
    ]
}

4 - 1.0

get /v1/kms/transit/{key_id}/users

Description

Get List of users who use 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.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathkey_id
required
Resource id of KMS key
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKKeyUserResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kms/transit/{key_id}/users

Request header

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

Example HTTP response

Response 200

{
    "user": [
        {
            "user_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "user_name": "kimsamsung"
        }
    ]
}