Get two-factor authentication information
- Print
- PDF
Get two-factor authentication information
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Get two-factor authentication information of a sub account.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v1/sub-accounts/{subAccountId}/mfa |
Request headers
For information about the headers common to all Sub Account APIs, see Sub Account request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
subAccountId | String | Required | Sub account ID |
Request example
The request example is as follows:
curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/mfa' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
isMfaMandatory | Boolean | - | Whether two-factor authentication is required
|
mfaList | Array | - | MFA configuration information |
mfaList
The following describes mfaList
.
Field | Type | Required | Description |
---|---|---|---|
mfaType | String | - | Two-factor authentication method type
|
Response status codes
For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.
Response example
The response example is as follows:
{
"isMfaMandatory": true,
"mfaList": [
{
"mfaType": "EMAIL"
},
{
"mfaType": "PASSKEY"
},
{
"mfaType": "PHONE"
}
]
}
Was this article helpful?