> ## Documentation Index
> Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL.
> Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other.
> Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking.
> Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify.

# Identity and access

> Explore 67 identity and access API operations.

[ All API services](https://zededa.mintlify.site/api-reference/overview.md)

&#x20;API SERVICE

# Identity and access

Manage users, roles, and access to your enterprise resources, including authentication, sessions, credentials, and policies.

[Browse endpoints ](#endpoint-groups)
[ Download OpenAPI](https://zededa.mintlify.site/openapi/services/iam.json)

START EXPLORING
Query users
[GET`/v1/users`](https://zededa.mintlify.site/api-reference/iam/get-v1-users)
Explore the parameters and response schema. Sign in from your console to try a request.
[Open endpoint ](https://zededa.mintlify.site/api-reference/iam/get-v1-users.md)

Ready to try the API?Browse every service and endpoint without signing in. Connect your ZedCloud session when you’re ready to send a request.

> [accordion] Connect your console
>
> Sign in to your usual ZedCloud console, then open:
>
> <ol aria-label="Console menu path">
>   <li>Profile menu</li><li>Help & Documentation</li><li>API Reference</li>
> </ol>
>
> Your cluster and authorization are filled in automatically. No token to copy.
> [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference)

&#x20;Modifying requests stay off until you enable them.

**67** operations  **2** groupsGET32POST16PUT12DELETE7

EXPLORE THE SERVICE

## Endpoint groups

Expand a group to find an endpoint.

58 operations

> [accordion] Identity and access management
>
> Users8 operations
>
> [GET**Query users**`/v1/users`](https://zededa.mintlify.site/api-reference/iam/get-v1-users)
> [GET**Get user by ID**`/v1/users/id/{id}`](https://zededa.mintlify.site/api-reference/iam/get-v1-users-id-by-id)
> [GET**Get user by name**`/v1/users/name/{name}`](https://zededa.mintlify.site/api-reference/iam/get-v1-users-name-by-name)
> [GET**Get own user**`/v1/users/self`](https://zededa.mintlify.site/api-reference/iam/get-v1-users-self)
> [POST**Create user**`/v1/users`](https://zededa.mintlify.site/api-reference/iam/post-v1-users)
> [PUT**Update user by ID**`/v1/users/id/{id}`](https://zededa.mintlify.site/api-reference/iam/put-v1-users-id-by-id)
> [PUT**Update user**`/v1/users/self`](https://zededa.mintlify.site/api-reference/iam/put-v1-users-self)
> [DELETE**Delete user**`/v1/users/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-users-id-by-id)
>
> Roles7 operations
>
> [GET**Query Roles**`/v1/roles`](https://zededa.mintlify.site/api-reference/iam/get-v1-roles)
> [GET**Get role by ID**`/v1/roles/id/{id}`](https://zededa.mintlify.site/api-reference/iam/get-v1-roles-id-by-id)
> [GET**Get role by name**`/v1/roles/name/{name}`](https://zededa.mintlify.site/api-reference/iam/get-v1-roles-name-by-name)
> [GET**Get own role**`/v1/roles/self`](https://zededa.mintlify.site/api-reference/iam/get-v1-roles-self)
> [POST**Create role**`/v1/roles`](https://zededa.mintlify.site/api-reference/iam/post-v1-roles)
> [PUT**Update role**`/v1/roles/id/{id}`](https://zededa.mintlify.site/api-reference/iam/put-v1-roles-id-by-id)
> [DELETE**Delete role**`/v1/roles/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-roles-id-by-id)
>
> Enterprises8 operations
>
> [GET**Query Enterprises**`/v1/enterprises`](https://zededa.mintlify.site/api-reference/iam/get-v1-enterprises)
> [GET**Get enterprise by ID**`/v1/enterprises/id/{id}`](https://zededa.mintlify.site/api-reference/iam/get-v1-enterprises-id-by-id)
> [GET**Get enterprise by name**`/v1/enterprises/name/{name}`](https://zededa.mintlify.site/api-reference/iam/get-v1-enterprises-name-by-name)
> [GET**Get own enterprise**`/v1/enterprises/self`](https://zededa.mintlify.site/api-reference/iam/get-v1-enterprises-self)
> [POST**Create Enterprise**`/v1/enterprises`](https://zededa.mintlify.site/api-reference/iam/post-v1-enterprises)
> [PUT**Update enterprise by ID**`/v1/enterprises/id/{id}`](https://zededa.mintlify.site/api-reference/iam/put-v1-enterprises-id-by-id)
> [PUT**Update enterprise**`/v1/enterprises/self`](https://zededa.mintlify.site/api-reference/iam/put-v1-enterprises-self)
> [DELETE**Delete enterprise**`/v1/enterprises/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-enterprises-id-by-id)
>
> Realms6 operations
>
> [GET**Query all realms**`/v1/realms`](https://zededa.mintlify.site/api-reference/iam/get-v1-realms)
> [GET**Get a realm**`/v1/realms/id/{id}`](https://zededa.mintlify.site/api-reference/iam/get-v1-realms-id-by-id)
> [GET**Get realm**`/v1/realms/name/{name}`](https://zededa.mintlify.site/api-reference/iam/get-v1-realms-name-by-name)
> [POST**Create a realm for an enterprise**`/v1/realms`](https://zededa.mintlify.site/api-reference/iam/post-v1-realms)
> [PUT**Update a realm**`/v1/realms/id/{id}`](https://zededa.mintlify.site/api-reference/iam/put-v1-realms-id-by-id)
> [DELETE**Delete a realm**`/v1/realms/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-realms-id-by-id)
>
> Authentication profiles6 operations
>
> [GET**Query AAA profiles**`/v1/authorization/profiles`](https://zededa.mintlify.site/api-reference/iam/get-v1-authorization-profiles)
> [GET**Get AAA profile by ID**`/v1/authorization/profiles/id/{id}`](https://zededa.mintlify.site/api-reference/iam/get-v1-authorization-profiles-id-by-id)
> [GET**Get AAA profile by name**`/v1/authorization/profiles/name/{name}`](https://zededa.mintlify.site/api-reference/iam/get-v1-authorization-profiles-name-by-name)
> [POST**Create AAA profile**`/v1/authorization/profiles`](https://zededa.mintlify.site/api-reference/iam/post-v1-authorization-profiles)
> [PUT**Update AAA profile**`/v1/authorization/profiles/id/{id}`](https://zededa.mintlify.site/api-reference/iam/put-v1-authorization-profiles-id-by-id)
> [DELETE**Delete AAA profile**`/v1/authorization/profiles/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-authorization-profiles-id-by-id)
>
> Sign-in and registration8 operations
>
> [POST**Login locally**`/v1/login`](https://zededa.mintlify.site/api-reference/iam/post-v1-login)
> [POST**Login externally**`/v1/login/external`](https://zededa.mintlify.site/api-reference/iam/post-v1-login-external)
> [POST**Reset forgotten password**`/v1/login/forgot`](https://zededa.mintlify.site/api-reference/iam/post-v1-login-forgot)
> [POST**Get AAA mode of the user**`/v1/login/mode`](https://zededa.mintlify.site/api-reference/iam/post-v1-login-mode)
> [POST**Login callback**`/v1/login/oauth/callback`](https://zededa.mintlify.site/api-reference/iam/post-v1-login-oauth-callback)
> [POST**Sign up for a new enterprise account**`/v1/login/signup/enterprise`](https://zededa.mintlify.site/api-reference/iam/post-v1-login-signup-enterprise)
> [POST**Register user**`/v1/login/signup/user`](https://zededa.mintlify.site/api-reference/iam/post-v1-login-signup-user)
> [POST**Logout**`/v1/logout`](https://zededa.mintlify.site/api-reference/iam/post-v1-logout)
>
> Sessions and tokens6 operations
>
> [GET**Query user sessions**`/v1/sessions`](https://zededa.mintlify.site/api-reference/iam/get-v1-sessions)
> [GET**Get current user session**`/v1/sessions/self`](https://zededa.mintlify.site/api-reference/iam/get-v1-sessions-self)
> [GET**Get user session**`/v1/sessions/token`](https://zededa.mintlify.site/api-reference/iam/get-v1-sessions-token)
> [GET**Get user session by token**`/v1/sessions/token/{sessionToken.base64}`](https://zededa.mintlify.site/api-reference/iam/get-v1-sessions-token-by-sessiontoken-base64)
> [POST**Generate a new session token**`/v1/sessions/token/self`](https://zededa.mintlify.site/api-reference/iam/post-v1-sessions-token-self)
> [PUT**Refresh current user session**`/v1/sessions/refresh`](https://zededa.mintlify.site/api-reference/iam/put-v1-sessions-refresh)
>
> Credentials4 operations
>
> [POST**Create credential**`/v1/credentials`](https://zededa.mintlify.site/api-reference/iam/post-v1-credentials)
> [PUT**Update credential**`/v1/credentials`](https://zededa.mintlify.site/api-reference/iam/put-v1-credentials)
> [PUT**Update own credential**`/v1/credentials/self`](https://zededa.mintlify.site/api-reference/iam/put-v1-credentials-self)
> [DELETE**Delete credential**`/v1/credentials/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-credentials-id-by-id)
>
> Policies5 operations
>
> [GET**Query document policy**`/v1/cloud/policies`](https://zededa.mintlify.site/api-reference/iam/get-v1-cloud-policies)
> [GET**Get document policy by id**`/v1/cloud/policies/id/{id}`](https://zededa.mintlify.site/api-reference/iam/get-v1-cloud-policies-id-by-id)
> [POST**Create document policy**`/v1/cloud/policies`](https://zededa.mintlify.site/api-reference/iam/post-v1-cloud-policies)
> [PUT**Mark document policy as latest**`/v1/cloud/policies/latest`](https://zededa.mintlify.site/api-reference/iam/put-v1-cloud-policies-latest)
> [DELETE**Deletes document policy by id**`/v1/cloud/policies/id/{id}`](https://zededa.mintlify.site/api-reference/iam/delete-v1-cloud-policies-id-by-id)

Users · Roles · Enterprises · Realms · Authentication profiles · Sign-in and registration · Sessions and tokens · Credentials · PoliciesGETPOSTPUTDELETE

9 operations

> [accordion] Entitlements and reports
>
> [GET**Get entitlement data for a enterprise**`/v1/entitlements`](https://zededa.mintlify.site/api-reference/iam/get-v1-entitlements)
> [GET**List enterprises with entitlement access**`/v1/entitlements/allowedenterprises`](https://zededa.mintlify.site/api-reference/iam/get-v1-entitlements-allowedenterprises)
> [GET**List enterprises with report access**`/v1/reports/allowedenterprises`](https://zededa.mintlify.site/api-reference/iam/get-v1-reports-allowedenterprises)
> [GET**Get appInst report**`/v1/reports/apps/instance`](https://zededa.mintlify.site/api-reference/iam/get-v1-reports-apps-instance)
> [GET**Get device report**`/v1/reports/device`](https://zededa.mintlify.site/api-reference/iam/get-v1-reports-device)
> [GET**Get plugin report**`/v1/reports/plugin`](https://zededa.mintlify.site/api-reference/iam/get-v1-reports-plugin)
> [GET**Get project report**`/v1/reports/project`](https://zededa.mintlify.site/api-reference/iam/get-v1-reports-project)
> [GET**Get user report**`/v1/reports/user`](https://zededa.mintlify.site/api-reference/iam/get-v1-reports-user)
> [PUT**Set entitlement data for a enterprise**`/v1/entitlements`](https://zededa.mintlify.site/api-reference/iam/put-v1-entitlements)

GETPUT

> [accordion] About this service
>
> ZEDEDA Identity and Access Management (IAM) Service helps you securely control access to zedcontrol resources. You use IAM to control who is authenticated (signed in) and authorized (has permissions) to use resources. ZEDEDA IAM Service helps you set up users and roles, and shows you how to protect your resources with role-based access control (RBAC). It also shows how to connect to other identity services to grant external users access to your enterprise resources.

API guides[ Authentication](https://zededa.mintlify.site/api-reference/authentication.md)[ Making requests](https://zededa.mintlify.site/api-reference/how-to-use-zededa-api.md)[ API availability](https://zededa.mintlify.site/api-reference/clusters.md)
