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 Allow empty: False Allowed values: [True, False]
type	string		Scope type in enabled state Example: GlobalValid Allow empty: False Allowed values: ['ValidOnFirstLogin', 'GlobalValid', 'Append']

Parameter Additional Explanation¶

type Parameter Explanation*

Allowed Values	Description
ValidOnFirstLogin	Indicates that the mapping configuration is only valid on the user's first login when the mapping configuration is enabled.
GlobalValid	Indicates that the mapping configuration is valid every time the user logs in when the mapping configuration is enabled; as the default value.
Append	Indicates that when the mapping configuration is enabled, the user account using single sign-on will append workspaces and assign roles according to the mapping rules. The original workspaces and roles of the account are not affected. If the member role is Standard, and the newly added mapping rule assigns Administrator, the user will have both Standard and Administrator roles.

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"
}