Skip to content

Switch Status Settings¶

POST /api/v1/login_mapping/set_disable

Overview¶

Body Request Parameters¶

Parameter Name	Type	Required	Description
isDisable	boolean		Whether to disable Example: True Can be empty: False Possible values: [True, False]
type	string		Scope type when enabled Example: GlobalValid Can be empty: False Possible values: ['ValidOnFirstLogin', 'GlobalValid']

Additional Parameter Information¶

Explanation of the type parameter *

Possible Values	Description
ValidOnFirstLogin	Indicates that under the enabled mapping configuration scenario, the mapping configuration is only valid during the user's first login
GlobalValid	Indicates that under the enabled mapping configuration scenario, the mapping configuration is valid every time the user logs in; serves as the default value

Request Example¶

curl 'https://external-api.guance.com/api/v1/login_mapping/set_disable' \
  -X 'POST' \
  -H 'Content-Type: application/json' \
  -H 'X-Df-Access-Key: <AK key>' \
  -H 'X-Df-Nonce: <random characters>' \
  -H 'X-Df-Signature: <signature>' \
  -H 'X-Df-Timestamp: <timestamp>' \
  --data-raw $'{"isDisable": true,"type": "GlobalValid"}'

Response¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-A70C8126-9E92-4DF5-B387-59BD9B63C587"
}