Available in Classic and VPC
Set the login information for external IdP.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
PUT | /api/v1/tenant/login-settings |
Request headers
For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
idleSessionExpDuration |
Integer | Required | Session expiration time of logged in external account (second)
|
multipleLoginAllowed |
Boolean | Required | Whether to allow duplicate login
|
possessionAuthenticationEnabled |
Boolean | Required | Whether to apply occupancy authentication
|
possessionAuthenticationTypes |
Array | Required | Occupancy authentication method type
|
multiFactorAuthenticationEnabled |
Boolean | Required | Whether to apply two-factor authentication
|
Request example
The request example is as follows:
curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/tenant/login-settings' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"idleSessionExpDuration": "600",
"multipleLoginAllowed": true,
"possessionAuthenticationEnabled": true,
"possessionAuthenticationTypes": [
"SMS",
"Email"
],
"multiFactorAuthenticationEnabled": true
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
success |
Boolean | - | API processing result
|
message |
String | - | Result message
|
Response status codes
For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.
Response example
The response example is as follows:
{
"success": true
}