SKskyfire

Enroll User in Agent Group

Changed on

As an Organization Admin, enroll an organization user in an agent group.

put/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 enroll. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

Response

Ok. The user was already enrolled; the existing enrollment is returned without apiKey.

userIdstring required

The enrolled organization user.

agentIdstring required

The user's existing instance of the group.

agentGroupIdstring required

The agent group.

displayNamestring required

The instance's display name, which is the group's name.

Changes