Update Access Group

curl -X PATCH 'https://app.memorylake.ai/openapi/memorylake/admin/v1/access-groups/7013fb5c15cfb29411f040967354b8a3' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Idempotency-Key: 7c1d2e3f-0a9b-4c8d-b7e6-f5a4d3c2b1a0' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Example description",
    "name": "Example name"
  }'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "created_at": 1760000000,
    "created_by": "example",
    "group_id": "6f8976043c3a1d0040a5853315a3c843",
    "member_count": 1,
    "name": "Example name",
    "permissions": [
      {
        "action": "example",
        "resource_type": "example"
      }
    ],
    "updated_at": 1760000000,
    "base_access_group_id": "d62d704744ca464eeee07a49ef8c2877",
    "base_role_key": "tenant_member",
    "description": "Example description",
    "scope_summary": [
      {
        "instance_count": 1,
        "resource_type": "example"
      }
    ]
  }
}

curl -X PATCH 'https://app.memorylake.ai/openapi/memorylake/admin/v1/access-groups/7013fb5c15cfb29411f040967354b8a3' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Idempotency-Key: 7c1d2e3f-0a9b-4c8d-b7e6-f5a4d3c2b1a0' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Example description",
    "name": "Example name"
  }'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "created_at": 1760000000,
    "created_by": "example",
    "group_id": "6f8976043c3a1d0040a5853315a3c843",
    "member_count": 1,
    "name": "Example name",
    "permissions": [
      {
        "action": "example",
        "resource_type": "example"
      }
    ],
    "updated_at": 1760000000,
    "base_access_group_id": "d62d704744ca464eeee07a49ef8c2877",
    "base_role_key": "tenant_member",
    "description": "Example description",
    "scope_summary": [
      {
        "instance_count": 1,
        "resource_type": "example"
      }
    ]
  }
}

PATCH /openapi/memorylake/admin/v1/access-groups/{group_id}

Renames an access group or changes its description. Only the fields you send change; null is rejected. The base role or base group cannot be changed. The response is the group as Get Access Group returns it, so view is required as well.

Permission required: access_group:manage and access_group:view

Path Parameters

string

required

Identifier

Headers

string

Optional. Retrying with the same value replays the first result.

Request Body

string

New description; "" clears it

string

New display name

curl -X PATCH 'https://app.memorylake.ai/openapi/memorylake/admin/v1/access-groups/7013fb5c15cfb29411f040967354b8a3' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Idempotency-Key: 7c1d2e3f-0a9b-4c8d-b7e6-f5a4d3c2b1a0' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Example description",
    "name": "Example name"
  }'

Response

object

Show Access Group object

integer

Unix seconds

string

principal_id of the creator

string

Identifier

integer

Number of members

string

Display name

array

Permissions the group grants on top of its base role or base group

Show Access Group Permission object

string

Action

string

Resource type (see GET /permission-catalog?grantable_to=access_group)

integer

Unix seconds

string

The group grants everything this other access group grants. Fixed at creation.

string

The group grants everything this role grants (tenant_member or tenant_admin). Fixed at creation.

string

Description

array

Instances the group gives access to, counted per resource type

Show Access Group Scope Count object

integer

Instances of this type the group gives its members access to

string

Resource type

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "created_at": 1760000000,
    "created_by": "example",
    "group_id": "6f8976043c3a1d0040a5853315a3c843",
    "member_count": 1,
    "name": "Example name",
    "permissions": [
      {
        "action": "example",
        "resource_type": "example"
      }
    ],
    "updated_at": 1760000000,
    "base_access_group_id": "d62d704744ca464eeee07a49ef8c2877",
    "base_role_key": "tenant_member",
    "description": "Example description",
    "scope_summary": [
      {
        "instance_count": 1,
        "resource_type": "example"
      }
    ]
  }
}

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.

Status	Meaning
`400`	A parameter or the body is invalid
`401`	The API key is missing, invalid, disabled or expired
`403`	The key is not allowed to do this
`404`	The resource does not exist
`409`	The request conflicts with the current state, e.g. a duplicate or a limit reached
`422`	The body or a parameter failed validation
`429`	Too many requests. Wait for the time in `Retry-After`
`500`	Server-side error
`503`	Temporarily unavailable. Retry later

MemoryLake API

Memory Router API

Path Parameters

Headers

Request Body

Response

Errors

​Path Parameters

​Headers

​Request Body

​Response

​Errors

Path Parameters

Headers

Request Body

Response

Errors