Zededa IdentityAccessManagement API
The IdentityAccessManagement API from Zededa — 38 operation(s) for identityaccessmanagement.
Zededa IdentityAccessManagement API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include IdentityAccessManagement. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 58 operations across 38 paths, and defines 140 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
58 operations
38 paths
140 schemas
7 DELETE24 GET16 POST11 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa IdentityAccessManagement API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (BearerToken).
By default, every request must be authenticated.
BearerToken— Bearer token for user session
Paths & Operations 58
Across 38 paths, the API surfaces 58 operations — 7 DELETE, 24 GET, 16 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.
IdentityAccessManagement 58
GET
/v1/authorization/profiles
Query AAA profiles
POST
/v1/authorization/profiles
Create AAA profile
GET
/v1/authorization/profiles/id/{id}
Get AAA profile
DELETE
/v1/authorization/profiles/id/{id}
Delete AAA profile
PUT
/v1/authorization/profiles/id/{id}
Update AAA profile
GET
/v1/authorization/profiles/name/{name}
Get AAA profile
GET
/v1/cloud/policies
Query document policy
POST
/v1/cloud/policies
Create document policy
GET
/v1/cloud/policies/id/{id}
Get document policy by id
DELETE
/v1/cloud/policies/id/{id}
Deletes document policy by id
PUT
/v1/cloud/policies/latest
Mark document policy as latest
POST
/v1/credentials
Create IAM credential
PUT
/v1/credentials
Update IAM credential
DELETE
/v1/credentials/id/{id}
Delete IAM credential
PUT
/v1/credentials/self
Update IAM credential
GET
/v1/enterprises
Query IAM Enterprises
POST
/v1/enterprises
Create IAM Enterprise
GET
/v1/enterprises/id/{id}
Get enterprise
DELETE
/v1/enterprises/id/{id}
Delete IAM role
PUT
/v1/enterprises/id/{id}
Update enterprise
GET
/v1/enterprises/name/{name}
Get enterprise
GET
/v1/enterprises/self
Get own enterprise
PUT
/v1/enterprises/self
Update enterprise
POST
/v1/login
Login locally
POST
/v1/login/external
Login externally
POST
/v1/login/forgot
Reset forgotten password
POST
/v1/login/mode
Get AAA mode of the user
POST
/v1/login/oauth/callback
Login callback
POST
/v1/login/signup/enterprise
Sign up for a new enterprise account
POST
/v1/login/signup/user
Get enterprise
POST
/v1/logout
Logout
GET
/v1/realms
Query all realms
POST
/v1/realms
Create a realm for an enterprise
GET
/v1/realms/id/{id}
Get a realm
DELETE
/v1/realms/id/{id}
Delete a realm
PUT
/v1/realms/id/{id}
Update a realm
GET
/v1/realms/name/{name}
Get IAM realm
GET
/v1/roles
Query IAM Roles
POST
/v1/roles
Create IAM role
GET
/v1/roles/id/{id}
Get IAM role
DELETE
/v1/roles/id/{id}
Delete IAM role
PUT
/v1/roles/id/{id}
Update IAM role
GET
/v1/roles/name/{name}
Get IAM role
GET
/v1/roles/self
Get own IAM role
GET
/v1/sessions
Query user sessions
PUT
/v1/sessions/refresh
Refresh current user session
GET
/v1/sessions/self
Get current user session
GET
/v1/sessions/token
Get user session
POST
/v1/sessions/token/self
Generate a new session token
GET
/v1/sessions/token/{sessionToken.base64}
Get user session
GET
/v1/users
Query IAM users
POST
/v1/users
Create IAM user
GET
/v1/users/id/{id}
Get IAM user
DELETE
/v1/users/id/{id}
Delete IAM user
PUT
/v1/users/id/{id}
Update IAM user
GET
/v1/users/name/{name}
Get IAM user
GET
/v1/users/self
Get own IAM user
PUT
/v1/users/self
Update IAM user
Schemas 140
The contract defines 140 schemas that model the data the API accepts and returns. The most detailed are DetailedUser (26 properties), Enterprise (20 properties), CrudResponseQuery (20 properties), AAA_Frontend_LoginResponse (16 properties). Each schema is shown below with its type and property counts.
AAAFailureResponseGenerateTokenCause
string
AAA_Frontend_LogoutRequest
object
Summary
object
Summary is used to store the Summary details
3 properties
AAAFailureResponse
object
8 properties
AAA_Frontend_OAUTHCallbackRequest
object
2 properties
UserUsagePerEnterpriseList
object
1 property
Role
object
Role meta data
9 properties
4 required
CrudStatisticsUser
object
3 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties
5 required
PasswordProfile
object
10 properties
UserUsagePerEnterprise
object
2 properties
OpaqueToken64
object
1 property
AAASuccessSessionDetailsResponse
object
3 properties
AAA_Frontend_LoginModeRequest
object
1 property
Policies
object
3 properties
AAANotifyResponse
object
3 properties
AAARedirectResponse
object
2 properties
AAASuccessResponseLogout
object
1 property
AAA_Frontend_SessionDetailsResponseCause
string
ZksSyncStatusCode
string
AuthType
string
CrudContentJSON
object
1 property
AAASuccessResponseQueryAllSessionDetails
object
2 properties
FeatureEntitlement
object
3 properties
AuthProfileType
string
Scope
object
11 properties
OAUTHProfileJWTAuthProfile
object
Config for JWT based authentication, jwksuri is derived from OIDC Well Known Endpoints
1 property
AuthorizationProfile
object
Authorization profile meta data
14 properties
3 required
Identifier64
object
1 property
AllowedEnterprise
object
3 properties
AAALoginModeResponseMode
string
Credentials
object
3 properties
IdState
string
AAAFailureResponseQueryAllSessionDetails
object
2 properties
AAARequestLoginForgotPassword
object
1 property
AAASuccessResponseType
string
TOTPSettings
object
3 properties
RoleState
string
Values for this needs to match the const defined in libs/database/datamodel.go for backward compatibility.
CrudResultWithContent
object
3 properties
AAA_Frontend_LogoutResponse
object
2 properties
AAA_Frontend_LoginModeResponseMode
string
Roles
object
3 properties
EnterpriseType
string
OAUTHProfile
object
9 properties
CredentialType
string
DetailedUser
object
User meta data
26 properties
3 required
PolicyScope
string
AAAFailureResponseCredentialChangeCause
string
AAAFailureResponseLogoutCause
string
AAASuccessResponse
object
8 properties
SimpleUser
object
5 properties
AAA_Frontend_GenerateTokenResponseCause
string
AAANotifyResponseType
string
AAA_Frontend_LogoutResponseCause
string
AAAResponseType
string
CrudResultCode
string
AdminUserSignup
object
6 properties
JWTAuthProfileAlgorithm
string
ObjectType
string
ZksSyncStatus
object
2 properties
AAA_Frontend_GenerateTokenResponse
object
7 properties
PolicyAccess
string
AAAFailureResponseGenerateToken
object
2 properties
AAA_Frontend_LoginWithOauthRequest
object
2 properties
CrudStatisticsContainer
object
2 properties
AAALoginModeResponse
object
2 properties
DeviceEntitlement
object
3 properties
protobufAny
object
2 properties
AAA_Frontend_SessionDetailsResponse
object
3 properties
AAA_Frontend_LoginResponseCause
string
DocPolicies
object
3 properties
Token64
object
2 properties
AAASuccessResponseGenerateToken
object
2 properties
UserEntitlement
object
2 properties
ModelClazz
string
Credential
object
7 properties
TOTPEnrolmentURL
object
2 properties
AAAFailureResponseQueryAllSessionDetailsCause
string
AAAFailureTokenRefreshCause
string
AllowedEnterpriseList
object
Get list of child enterprises
5 properties
CrudResponseRead
object
1 property
CrudContentEncoding
string
PluginTypeEntitlement
object
3 properties
EnterpriseState
string
ZsrvError
object
3 properties
AAAFailureResponseSessionDetailsCause
string
Enterprises
object
3 properties
AAASuccessTokenRefresh
object
1 property
AAAResponse
object
8 properties
Realm
object
Realm meta data
6 properties
3 required
CrudResponse
object
5 properties
LastLoggedinUserInfo
object
2 properties
Entitlement
object
Get Entitlement data
6 properties
PolicyVersionList
object
1 property
DataStream
object
2 properties
AAAFailureTokenRefresh
object
3 properties
UserSummaryReport
object
3 properties
ProjectList
object
1 property
AAA_Frontend_RefreshResponse
object
3 properties
PluginEntitlement
object
3 properties
Enterprise
object
Enterprise meta data
20 properties
2 required
DocPolicySummary
object
DocPolicy meta data
4 properties
AAA_Frontend_RefreshResponseCause
string
ZcOpsType
string
CrudContent
object
5 properties
EnterpriseSummary
object
2 properties
AAASuccessResponseLogin
object
15 properties
Realms
object
3 properties
AAARequestAdminUserSignup
object
7 properties
PolicyVersion
object
5 properties
AAA_Frontend_LoginModeResponse
object
2 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
AAAFailureResponseLoginCause
string
DeviceSize
string
AAAFailureResponseLogin
object
5 properties
AAAFailureResponseCredentialChange
object
1 property
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
AAA_Frontend_LoginWithPasswordRequest
object
User either a combination of (username, realm) or (usernameAtRealm) to specify login details
10 properties
Policy
object
6 properties
CrudContentProtobuf
object
12 properties
DocPolicy
object
DocPolicy meta data
7 properties
1 required
DetailedUsers
object
5 properties
AAASuccessResponseCredentialChange
object
1 property
googlerpcStatus
object
3 properties
AAAFailureResponseLogout
object
3 properties
UserState
string
CrudAction
string
AAARequestEnterpriseSignup
object
7 properties
ServerSyncStatus
object
3 properties
AAA_Frontend_LoginResponse
object
16 properties
PluginType
string
AAAFailureResponseType
string
AAASuccessResponseQueryAllSessionDetailsCause
string
ZsrvResponse
object
15 properties
CrudResponseQuery
object
20 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
UserRole
string
AuthorizationProfiles
object
3 properties
AAAFailureResponseSessionDetails
object
2 properties
SessionDetails
object
Details of all logged in session
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zededa 12
Other APIs Zededa publishes across the network.
Zededa AppProfileService API
Zededa ArtifactManager API
Zededa AssetGroupService API
Zededa BulkJobOps API
Zededa CertificateEnrollmentProfileConfiguration API
Zededa CloudDiagnostics API
Zededa ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API
#IdentityAccessManagement