def get(
id: str,
*,
timeout: float | None = None,
) -> RoleResourceasync def get(
id: str,
*,
timeout: float | None = None,
) -> RoleResourceReads a single role. Unlike products and projects, there is no slug form here: the argument must be the role id taken from list, and a role name or a system key such as owner comes back as 404 role.not_found.
For a system role, permissions is the canonical catalogue list for its systemKey rather than the stored column, so it stays correct as the platform permission set grows. systemKey is None for custom roles, and isSystem is the flag to branch on before offering an edit or delete action, since both are refused on system roles.
Example
from envless import envless
role = envless.roles.list_all(search='deploy')[0]
detail = envless.roles.get(role['id'])
print(detail['permissions'])import asyncio
from envless import AsyncEnvless
async def main() -> None:
async with AsyncEnvless() as envless:
role = (await envless.roles.list_all(search='deploy'))[0]
detail = await envless.roles.get(role['id'])
print(detail['permissions'])
asyncio.run(main())Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | str | Yes | Role id from roles.list, with no name or slug form accepted. |
timeout | float | No | Seconds each attempt of this call may take, the response body included, before it raises EnvlessNetworkError with is_timeout set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
RoleResource with permissions, isSystem, systemKey and timestamps.
Worth knowing
- A soft deleted role is indistinguishable from one that never existed: both answer 404
role.not_found. - The role must belong to the workspace the API key is bound to, since ids from another workspace also read as 404.
Required scopes
roles:read
Underlying endpoint
GET /roles/{id}
Request and response schema, every error code, and a live playground.
In TypeScript
envless.roles.get()
The same method in @goenvless/sdk, with the same request, retries and errors.