Unenroll User from Agent Group

Changed on

As an Organization Admin, remove a user from an agent group. Their instance of the group is deactivated and its cards are removed.

delete/api/v1/agent-groups/{agentGroupId}/enrollments/{userId}

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/agent-groups/{agentGroupId}/enrollments/{userId}
  • Auth
    API key in header skyfire-api-key

Path parameters

agentGroupIdstring uuid required

Unique identifier of the agent group. e.g. "215f6804-cd50-4c42-9c14-98db7312718d"

userIdstring uuid required

Unique identifier of the organization user to unenroll. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

Response

No Content. The user is unenrolled; the instance is deactivated and its cards removed.

Changes