Skip to content
Authrim

Update mutable Agent Grant metadata and require renewed consent.

PATCH
/api/admin/agent-grants/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/agent-grants/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "authorization_details": [ { "additionalProperty": "example" } ], "purpose": "example", "expires_at": 1 }'

Task Set, Scope Policy, resolved Tools, permissions, and scopes are immutable. This operation updates mutable metadata while revalidating the updater, original grantor, delegator, and optional Machine Principal ceilings. The Grant generation and consent version, prior consent revocation, token-family revocation outbox, and audit event are committed atomically. Extending expires_at is the explicit recertification operation and requires renewed consent.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
/^aag_/

Agent Grant identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
>= 1 properties
authorization_details
Array<object>
<= 20 items
object
key
additional properties
purpose
string | null
<= 500 characters
expires_at

Required time-bounded recertification deadline, no more than 90 days from the update.

integer format: int64
key
additional properties
Example generated
{
  "authorization_details": [
    {
      "additionalProperty": "example"
    }
  ],
  "purpose": "example",
  "expires_at": 1
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Grant updated and old authorization invalidated.

Media type application/json
object
grant_id
required
string
status
required
string
Allowed values: active
generation
required
integer
>= 2
consent_version
required
integer
>= 2
token_families_pending_revocation
required
integer
revocation_outbox_id
required
string
consent_required
required
boolean
key
additional properties
Example 
{
  "status": "active",
  "consent_required": true
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}