Update Agent Group

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401.

All fields are optional; only the fields you send are changed. The group is resolved within your own organization; a group that does not exist or belongs to another organization returns 404.

Renaming

Renaming a group renames every active member agent in the same transaction, so each enrolled user's instance keeps presenting the group's name. Tokens minted after a rename carry the new name as aid.name. API keys cache the agent they belong to for up to 60 seconds, so a token minted within a minute of the rename may still show the old name.

The new name follows the rules in Create Agent Group: printable ASCII, 1 to 100 characters, unique among your groups after folding. While the group is active it also may not match an active ungrouped agent's name in your organization. A collision returns 409. An inactive group may share a name with an ungrouped agent, since it is not presenting that name; reactivating it then requires the name to be free again.

Deactivating and reactivating

active: false pauses the group. Member agents are not modified: they stay active and keep their keys, cards, and wallets, but no member can obtain a token (400), and no user can be enrolled (400) until the group is reactivated. Member agents report status: "group_inactive" in agent listings while the group is paused.

active: true reactivates the group, re-checking its name against the organization's namespace. There is no delete; a group you no longer use stays deactivated.

Path Params
uuid
required

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

Body Params
string
length between 1 and 100

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

string | null

New description. Send null to clear it.

boolean

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.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json