Delete User (master token)
POST https://{{base_url}}/graphql
This mutation is used to delete an external user from your Embedded application.
Note: Deleting a user will also disable and delete all Solution Instances associated with that user.
Required Token | Notes |
---|---|
Master | Obtained from the Tray app UI |
The mutation accepts the following as inputs:
Input | Required | Notes |
---|---|---|
userId | Yes | obtained with Queries/Users/Get Users |
clientMutationId | No | Only relevant if using the Relay GraphQL client |
It can return the following data:
Returned Data | Notes |
---|---|
clientMutationId | while this data is only relevant if using the Relay GraphQL client, it is actually required here as currently this mutation does not return any other data |
RESPONSES
status: OK
{"data":{"removeExternalUser":{"clientMutationId":"someClientMutationId"}}}