Skip to content

docs(rest): align Roles 'global_access' usage and DELETE-SA token-invalidation status with backend #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rohan-chaturvedi merged 1 commit into from
May 28, 2026
Merged

docs(rest): align Roles 'global_access' usage and DELETE-SA token-invalidation status with backend #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions src/pages/public-api/roles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Responses use camelCase keys (`appPermissions`, `globalAccess`). On POST and PUT
The role name. Maximum 64 characters. Must be unique within the organisation (case-insensitive).
</Property>
<Property name="permissions" type="object">
The permissions object. Must include `permissions` (org-level), `app_permissions` (app-level), and `global_access` (boolean).
The permissions object. Must contain exactly two keys: `permissions` (org-level) and `app_permissions` (app-level). The `global_access` flag cannot be set on custom roles — POST and PUT reject requests that include `global_access` (or `globalAccess`) under `permissions` with `400 Bad Request`.
</Property>
</Properties>

Expand Down Expand Up @@ -260,8 +260,7 @@ Responses use camelCase keys (`appPermissions`, `globalAccess`). On POST and PUT
"app_permissions": {
"Secrets": ["read"],
"Environments": ["read"]
},
"global_access": false
}
}
}'
```
Expand Down Expand Up @@ -289,7 +288,6 @@ Responses use camelCase keys (`appPermissions`, `globalAccess`). On POST and PUT
'Secrets': ['read'],
'Environments': ['read'],
},
'global_access': False,
}
}

Expand Down Expand Up @@ -345,7 +343,7 @@ Responses use camelCase keys (`appPermissions`, `globalAccess`). On POST and PUT

### JSON Body

When `permissions` is provided, the full object replaces the stored permissions and must contain all three keys: `permissions`, `app_permissions`, and `global_access`. The camelCase variants `appPermissions` and `globalAccess` are also accepted on input.
When `permissions` is provided, the full object replaces the stored permissions and must contain exactly two keys: `permissions` and `app_permissions`. The camelCase variant `appPermissions` is also accepted on input. Sending `global_access` (or `globalAccess`) under `permissions` returns `400 Bad Request`.

<Properties>
<Property name="name" type="string">
Expand Down Expand Up @@ -386,8 +384,7 @@ Responses use camelCase keys (`appPermissions`, `globalAccess`). On POST and PUT
"Secrets": ["read"],
"Environments": ["read"],
"Logs": ["read"]
},
"global_access": false
}
}
}'
```
Expand Down
2 changes: 1 addition & 1 deletion src/pages/public-api/service-accounts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ When fetching a single service account, additional detail fields are included:
<Row>
<Col>

Delete a service account. All associated tokens are immediately invalidated (subsequent requests with those tokens return `403 Forbidden`), and all app/environment access grants are removed.
Delete a service account. All associated tokens are immediately invalidated (subsequent requests with those tokens return `401 Unauthorized` with `{"error": "Token expired or deleted"}`), and all app/environment access grants are removed.

### URL parameters

Expand Down