【Login Mapping】Add a mapping configuration - Guance Docs

Skip to content

POST /api/v1/login_mapping/field/add

Overview¶

Body Request Parameters¶

Parameter Name	Type	Required	Description
workspaceUUID	string	Y	Workspace UUID Example: Workspace UUID Allow empty: False
sourceField	string	Y	Source field Example: sourceField Allow empty: False Maximum length: 40
sourceValue	string	Y	Source field value Example: Allow empty: False Maximum length: 40
targetValues	array	Y	Target field values (currently defaults to the UUID of roles) Example: ['readOnly']

Additional Parameter Explanation¶

Request Example¶

curl '<Endpoint>/api/v1/login_mapping/field/add' \
  -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 $'{"workspaceUUID": "wksp_xxxx","sourceField": "email","sourceValue": "xxx@qq.com","targetValues": [  "readOnly"]}'

Response¶

{
    "code": 200,
    "content": {
        "createAt": 1715323808,
        "creator": "sys",
        "deleteAt": -1,
        "id": null,
        "isSystem": true,
        "sourceField": "email",
        "sourceValue": "xxx@qq.com",
        "status": 0,
        "targetValues": [
            "readOnly"
        ],
        "updateAt": 1715323808,
        "updator": "sys",
        "uuid": "lgmp_xxxxx",
        "workspaceUUID": "wksp_xxxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-978CA704-5646-45D8-ACAE-84975BDD2250"
}