Update an Access Key | Tigris Object Storage Documentation
Update an Access Key
PUT https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/key
Updates the access key details like user role and bucket access permissions.
Request
Path Parameters
provider_id string required
Provider ID
org_id string required
Organization ID
application/json
Body
Example (auto)
Body required
user_id string required
ID of the user for whom the access key is being updated
id string required
Access key ID
user_role OrgMembership
Role of the user in the organization. Controls what the user can do
through the Partner API management endpoints.
Admin: Full org access. Can list and manage all access keys in the
org, update org settings, and manage users. ListAccessKeys returns
all keys in the org.Member: Standard access. Can only manage their own access keys.
ListAccessKeys returns only keys owned by this user.
If omitted, defaults to Member behavior.
Possible values: [Admin, Member]
buckets_roles object[]
Array [
bucket_name string required
Name of the bucket
role string required
The role defines the permissions for the associated bucket:
ReadOnly: Read-only access to the bucket. Permits read
operations like GetObject, HeadObject, ListObjects.Editor: Read and write access to the bucket. Includes
everything in ReadOnly, plus PutObject, DeleteObject, and bucket
configuration operations.Admin: Full access to all buckets in the org, bypasses all
permission checks. When used withbucket_name: "*", the access
key is treated as a full org admin. The value ofbucket_name
should always be*when using this role.
Example:
{
"bucket_name": "*",
"role": "Admin"
}
Possible values: [ReadOnly, Editor, Admin]
]
add_policies string[]
Names of IAM policies to attach to this access key. Policies already attached are ignored.
Can be combined with remove_policies in the same request — removals are applied first.
remove_policies string[]
Names of IAM policies to detach from this access key. Policies not currently attached are ignored.
access_key_scope AccessKeyScope
Omitting this field leaves the key's current scope unchanged.
Possible values: [standard, no_default_allow]
{
"user_id": "string",
"id": "string",
"user_role": "Admin",
"buckets_roles": [
{
"bucket_name": "string",
"role": "ReadOnly"
}
],
"add_policies": [
"string"
],
"remove_policies": [
"string"
],
"access_key_scope": "standard"
}
Responses
- 200
- default
OK
application/json
Schema
Example (auto)
Schema
object object
{}
Unexpected error
application/json
Schema
Example (auto)
Schema
message string
{
"message": "string"
}
Authorization: X-Tigris-Signature
name: X-Tigris-Signature
type: apiKey
in: header
description: HMAC-SHA256 of the canonical request signed using the signing key.
To create the signature, concatenate the HTTP method, URL, timestamp, and nonce with a newline character in between.
Then, calculate the HMAC-SHA256 of the concatenated string using the signing key. Example:
Create the `canonical_request` as:
```
POST
https://mgmt.storage.dev/provider/your-provider-id/orgs/user-org-id/provision
1731703213870
f8d133cb-5a42-47b1-9ef2-874bb55bab72
```
Then, calculate HMAC-SHA256 of the canonical request using the signing key as:
```
Signature = hex(sha256sign(canonical_request, "signing_key"))
```
name: X-Tigris-Nonce
type: apiKey
in: header
description: Random unique string to identify the request and prevent replay attacks. Example: "f8d133cb-5a42-47b1-9ef2-874bb55bab72"
name: X-Tigris-Time
type: apiKey
in: header
description: Unix timestamp in milliseconds of the request. Example: 1731703213870
csharp
curl
dart
go
http
java
javascript
kotlin
c
nodejs
objective-c
ocaml
php
postman-cli
powershell
python
r
ruby
rust
shell
swift
HTTPCLIENT
RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/key");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Tigris-Signature", "<X-Tigris-Signature>");
request.Headers.Add("X-Tigris-Nonce", "<X-Tigris-Nonce>");
request.Headers.Add("X-Tigris-Time", "<X-Tigris-Time>");
var content = new StringContent("{\n \"user_id\": \"string\",\n \"id\": \"string\",\n \"user_role\": \"Admin\",\n \"buckets_roles\": [\n {\n \"bucket_name\": \"string\",\n \"role\": \"ReadOnly\"\n }\n ],\n \"add_policies\": [\n \"string\"\n ],\n \"remove_policies\": [\n \"string\"\n ],\n \"access_key_scope\": \"standard\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
RequestCollapse all
Base URL
Edit
Auth
Signature
Nonce
Timestamp
Parameters
provider_id — path required
org_id — path required
Body required
Send API Request
ResponseClear
Click the Send API Request button above and see the response here!