Authorizations
API key authentication. Get your API key from the Formal dashboard.
Body
application/json
Response
Success
curl -X POST "https://api.joinformal.com/core.v1.GroupService/CreateUserGroupLink" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example": "value"
}'{
"userGroupLink": {
"id": "<string>",
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"dsyncGroupId": "<string>",
"terminationProtection": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z"
},
"user": {
"id": "<string>",
"dbUsername": "<string>",
"type": "machine",
"terminationProtection": true,
"expireAt": "2023-01-15T01:30:15.01Z",
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z",
"human": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com"
}
},
"terminationProtection": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z"
}
}curl -X POST "https://api.joinformal.com/core.v1.GroupService/CreateUserGroupLink" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example": "value"
}'{
"userGroupLink": {
"id": "<string>",
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"dsyncGroupId": "<string>",
"terminationProtection": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z"
},
"user": {
"id": "<string>",
"dbUsername": "<string>",
"type": "machine",
"terminationProtection": true,
"expireAt": "2023-01-15T01:30:15.01Z",
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z",
"human": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com"
}
},
"terminationProtection": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z"
}
}API key authentication. Get your API key from the Formal dashboard.
Success
Show child attributes
Was this page helpful?