【Login Mapping】Switch status setting - Guance Docs

Skip to content

POST /api/v1/login_mapping/set_disable

Overview¶

Body Request Parameters¶

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

Additional Parameter Explanations¶

Explanation of the type parameter *

Optional Value	Description
ValidOnFirstLogin	Indicates that the mapping configuration is only effective for the user's first login when enabled.
GlobalValid	Indicates that the mapping configuration is effective for each user login when enabled; serves as the default value.

Request Example¶

curl '<Endpoint>/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"
}