Add subjects to personas

POST /api/service/personas/{id}/subjects

Add users and / or groups to personas.

Path parameters

  • id string Required

    Unique identifier of the persona to which to add subjects.

Body Required

Users and groups to be added to the persona.

Note that both properties are required, even if one of them is only an empty array.

  • users array[string] Required

    List of unique identifiers (GUIDs) of users to be added to the persona.

  • groups array[string] Required

    List of unique identifiers (GUIDs) of groups to be added to the persona.

Responses

  • 200

    Successfully attached user(s)/group(s) to persona

    Note that there is no content returned by this API when successful.

  • 400 object

    Bad request: for example, because some required parameter is missing.

    • code integer

      Unique code for the type of error that occurred.

    • error string

      High-level description of the error. This will typically be the words keycloak error.

    • info string | null
    • message string

      More detailed message regarding the error that occurred.

POST /api/service/personas/{id}/subjects
curl \
 -X POST https://tenant.atlan.com/api/service/personas/9bee3ff8-9bf4-436f-927b-3e415fd3afe9/subjects \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"users":["62fb7f0b-95ea-4503-b567-0fbfedaf5779","eca7b001-1763-45ca-9440-cc984650495e","16049e68-653a-48fa-887f-cb82f20867b8"],"groups":["2a9f062d-485b-458d-96ee-1b82a19a1333"]}'
Request example
{
  "users": [
    "62fb7f0b-95ea-4503-b567-0fbfedaf5779",
    "eca7b001-1763-45ca-9440-cc984650495e",
    "16049e68-653a-48fa-887f-cb82f20867b8"
  ],
  "groups": [
    "2a9f062d-485b-458d-96ee-1b82a19a1333"
  ]
}
Response example (400)
{
  "code": 1000,
  "error": "Please check your request parameters",
  "info": null,
  "message": "Request body has an error: doesn't match the schema: Property 'users' is missing",
  "requestId": "hLh3uCax9fDaUZrkRUNFGiecKKDJdllK"
}