Update application identity scope

PATCH

/secret-store/scopes/:scope_id

Updates store access and version permissions for a scope. Requires scope: secret-store.write.

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

scope_idstringRequired

Secret Store identity scope ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.

access_modeenumOptional

allow_version_readbooleanOptional

allow_rollbackbooleanOptional

allow_destroybooleanOptional

Response

Scope updated successfully.

idstring

identity_idstring

scope_typestring

store_idstring

organization_idstring

workspace_idstring

access_modeenum

allow_version_readboolean

allow_rollbackboolean

allow_destroyboolean

created_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl -X PATCH "https://api.ibee.ai/v1/secret-store/scopes/scope_id?workspace_id=710995" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"access_mode": "read_write",
>	"allow_version_read": true,
>	"allow_rollback": true,
>	"allow_destroy": false
>	}'

1	{
2	"id": "string",
3	"identity_id": "string",
4	"scope_type": "string",
5	"store_id": "string",
6	"organization_id": "string",
7	"workspace_id": "string",
8	"access_mode": "read_only",
9	"allow_version_read": true,
10	"allow_rollback": true,
11	"allow_destroy": true,
12	"created_at": "2024-01-15T09:30:00Z"
13	}