SKskyfire

Update Agent Group

Changed on

As an Organization Admin, rename, describe, deactivate, or reactivate an agent group in your organization.

patch/api/v1/agent-groups/{agentGroupId}

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/agent-groups/{agentGroupId}
  • 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"

Request body

namestring

New name for the group and all of its active member agents. Same rules as on creation.

descriptionstring nullable

New description. Send null to clear it.

activeboolean

false pauses the group: no member can obtain a token and no user can be enrolled until it is reactivated. true reactivates it. Member agents are not modified.

Response

Ok

idstring required

Unique identifier of the agent group.

namestring required

The group's name after the update.

descriptionstring nullable required

The group's description after the update, or null.

activeboolean required

Whether the group is active after the update.

createdAtstring required

When the group was created.

updatedAtstring required

When the group was last changed.

Changes