Skip to main content
All API services

API SERVICE

​
Identity and access

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

Browse endpoints Download OpenAPI

START EXPLORING

​
Query users

GET/v1/users

Explore the parameters and response schema. Sign in from your console to try a request.

Open endpoint

67 operations 2 groups

GET32POST16PUT12DELETE7

EXPLORE THE SERVICE

​
Endpoint groups

Expand a group to find an endpoint.

58 operations
Users8 operations
GETQuery users/v1/usersGETGet user by ID/v1/users/id/{id}GETGet user by name/v1/users/name/{name}GETGet own user/v1/users/selfPOSTCreate user/v1/usersPUTUpdate user by ID/v1/users/id/{id}PUTUpdate user/v1/users/selfDELETEDelete user/v1/users/id/{id}
Roles7 operations
GETQuery Roles/v1/rolesGETGet role by ID/v1/roles/id/{id}GETGet role by name/v1/roles/name/{name}GETGet own role/v1/roles/selfPOSTCreate role/v1/rolesPUTUpdate role/v1/roles/id/{id}DELETEDelete role/v1/roles/id/{id}
Enterprises8 operations
GETQuery Enterprises/v1/enterprisesGETGet enterprise by ID/v1/enterprises/id/{id}GETGet enterprise by name/v1/enterprises/name/{name}GETGet own enterprise/v1/enterprises/selfPOSTCreate Enterprise/v1/enterprisesPUTUpdate enterprise by ID/v1/enterprises/id/{id}PUTUpdate enterprise/v1/enterprises/selfDELETEDelete enterprise/v1/enterprises/id/{id}
Realms6 operations
GETQuery all realms/v1/realmsGETGet a realm/v1/realms/id/{id}GETGet realm/v1/realms/name/{name}POSTCreate a realm for an enterprise/v1/realmsPUTUpdate a realm/v1/realms/id/{id}DELETEDelete a realm/v1/realms/id/{id}
Authentication profiles6 operations
GETQuery AAA profiles/v1/authorization/profilesGETGet AAA profile by ID/v1/authorization/profiles/id/{id}GETGet AAA profile by name/v1/authorization/profiles/name/{name}POSTCreate AAA profile/v1/authorization/profilesPUTUpdate AAA profile/v1/authorization/profiles/id/{id}DELETEDelete AAA profile/v1/authorization/profiles/id/{id}
Sign-in and registration8 operations
POSTLogin locally/v1/loginPOSTLogin externally/v1/login/externalPOSTReset forgotten password/v1/login/forgotPOSTGet AAA mode of the user/v1/login/modePOSTLogin callback/v1/login/oauth/callbackPOSTSign up for a new enterprise account/v1/login/signup/enterprisePOSTRegister user/v1/login/signup/userPOSTLogout/v1/logout
Sessions and tokens6 operations
GETQuery user sessions/v1/sessionsGETGet current user session/v1/sessions/selfGETGet user session/v1/sessions/tokenGETGet user session by token/v1/sessions/token/{sessionToken.base64}POSTGenerate a new session token/v1/sessions/token/selfPUTRefresh current user session/v1/sessions/refresh
Credentials4 operations
POSTCreate credential/v1/credentialsPUTUpdate credential/v1/credentialsPUTUpdate own credential/v1/credentials/selfDELETEDelete credential/v1/credentials/id/{id}
Policies5 operations
GETQuery document policy/v1/cloud/policiesGETGet document policy by id/v1/cloud/policies/id/{id}POSTCreate document policy/v1/cloud/policiesPUTMark document policy as latest/v1/cloud/policies/latestDELETEDeletes document policy by id/v1/cloud/policies/id/{id}

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

GETPOSTPUTDELETE
9 operations
GETPUT

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