{ "opencollection": "1.0.0", "info": { "name": "ZEDEDA App Profiles Service AppProfileService IdentityAccessManagement API", "version": "1.0" }, "items": [ { "info": { "name": "IdentityAccessManagement", "type": "folder" }, "items": [ { "info": { "name": "Query AAA profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/authorization/profiles", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "summary", "value": "", "type": "query" }, { "name": "SfdcId", "value": "", "type": "query" }, { "name": "HubspotId", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "namePattern", "value": "", "type": "query" }, { "name": "all", "value": "", "type": "query" }, { "name": "roleName", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "next.pageToken", "value": "", "type": "query", "description": "Page Token" }, { "name": "next.orderBy", "value": "", "type": "query", "description": "OrderBy helps in sorting the list response" }, { "name": "next.pageNum", "value": "", "type": "query", "description": "Page Number" }, { "name": "next.pageSize", "value": "", "type": "query", "description": "Defines the page size" }, { "name": "next.totalPages", "value": "", "type": "query", "description": "Total number of pages to be fetched." } ] }, "docs": "Query the AAA profile records." }, { "info": { "name": "Create AAA profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/authorization/profiles", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create an AAA profile record." }, { "info": { "name": "Get AAA profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/authorization/profiles/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) of an AAA profile record." }, { "info": { "name": "Update AAA profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/authorization/profiles/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique system defined profile ID" } ] }, "docs": "Update an AAA profile record. The usual pattern to update an AAA profile record is to retrieve the record and update with the modified values in a new body to update the AAA profile record." }, { "info": { "name": "Delete AAA profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/authorization/profiles/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an AAA profile record." }, { "info": { "name": "Get AAA profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/authorization/profiles/name/:name", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) of an AAA profile record." }, { "info": { "name": "Query document policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cloud/policies", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "summary", "value": "", "type": "query" }, { "name": "SfdcId", "value": "", "type": "query" }, { "name": "HubspotId", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "namePattern", "value": "", "type": "query" }, { "name": "all", "value": "", "type": "query" }, { "name": "roleName", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "next.pageToken", "value": "", "type": "query", "description": "Page Token" }, { "name": "next.orderBy", "value": "", "type": "query", "description": "OrderBy helps in sorting the list response" }, { "name": "next.pageNum", "value": "", "type": "query", "description": "Page Number" }, { "name": "next.pageSize", "value": "", "type": "query", "description": "Defines the page size" }, { "name": "next.totalPages", "value": "", "type": "query", "description": "Total number of pages to be fetched." } ] }, "docs": "Query document policy" }, { "info": { "name": "Create document policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/cloud/policies", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create document policy." }, { "info": { "name": "Get document policy by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cloud/policies/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get document policy by id" }, { "info": { "name": "Deletes document policy by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/cloud/policies/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes document policy by id" }, { "info": { "name": "Mark document policy as latest", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/cloud/policies/latest", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Mark document policy as latest." }, { "info": { "name": "Create IAM credential", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/credentials", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create an IAM credential record." }, { "info": { "name": "Update IAM credential", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/credentials", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Update an IAM credential record." }, { "info": { "name": "Delete IAM credential", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/credentials/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an IAM credential record." }, { "info": { "name": "Update IAM credential", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/credentials/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Update user's own IAM credential record." }, { "info": { "name": "Query IAM Enterprises", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/enterprises", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "summary", "value": "", "type": "query" }, { "name": "SfdcId", "value": "", "type": "query" }, { "name": "HubspotId", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "namePattern", "value": "", "type": "query" }, { "name": "all", "value": "", "type": "query" }, { "name": "roleName", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "next.pageToken", "value": "", "type": "query", "description": "Page Token" }, { "name": "next.orderBy", "value": "", "type": "query", "description": "OrderBy helps in sorting the list response" }, { "name": "next.pageNum", "value": "", "type": "query", "description": "Page Number" }, { "name": "next.pageSize", "value": "", "type": "query", "description": "Defines the page size" }, { "name": "next.totalPages", "value": "", "type": "query", "description": "Total number of pages to be fetched." } ] }, "docs": "Query the IAM Enterprises records." }, { "info": { "name": "Create IAM Enterprise", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/enterprises", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create an IAM enterprise record." }, { "info": { "name": "Get enterprise", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/enterprises/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) and status of an enterprise record." }, { "info": { "name": "Update enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/enterprises/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique system defined enterprise ID" } ] }, "docs": "Update an enterprise record. The usual pattern to update an enterprise record is to retrieve the record and update with the modified values in a new body to update the enterprise record." }, { "info": { "name": "Delete IAM role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/enterprises/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an IAM enterprise record." }, { "info": { "name": "Get enterprise", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/enterprises/name/:name", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) and status of an enterprise record." }, { "info": { "name": "Get own enterprise", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/enterprises/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Get the configuration (without security details) and status of user's own enterprise record." }, { "info": { "name": "Update enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/enterprises/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Update an enterprise record. The usual pattern to update an enterprise record is to retrieve the record and update with the modified values in a new body to update the enterprise record." }, { "info": { "name": "Login locally", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Login with zedcontrol as identity provider." }, { "info": { "name": "Login externally", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login/external", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Login with external identity provider (e.g. Okta, gmail, Azure AD etc.). If the enterprise has an AAA Profile configured, zedcontrol will redirect the user to the login page of the external identity provider." }, { "info": { "name": "Reset forgotten password", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login/forgot", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Reset password in case it is forgotten" }, { "info": { "name": "Get AAA mode of the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login/mode", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Get the AAA mode of the user. AAA mode can be authentication and authorization with zedcontrol as identity provider or authentication (and optionally authorization) with external identity provider. Oauth2 is supported for external authentication protocols." }, { "info": { "name": "Login callback", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login/oauth/callback", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Login callback for external OAauth2 identity provider" }, { "info": { "name": "Sign up for a new enterprise account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login/signup/enterprise", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Sign up for a new enterprise account in zedcontrol. Enterprise will not be active unless admin user is validated with email." }, { "info": { "name": "Get enterprise", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/login/signup/user", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Get the configuration (without security details) and status of an enterprise record." }, { "info": { "name": "Logout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/logout", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Logout from zedcontrol. Current user session will be terminated. In case of login with external identity provider, user session in the identity provider will not be impacted." }, { "info": { "name": "Query all realms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/realms", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "summary", "value": "", "type": "query" }, { "name": "SfdcId", "value": "", "type": "query" }, { "name": "HubspotId", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "namePattern", "value": "", "type": "query" }, { "name": "all", "value": "", "type": "query" }, { "name": "roleName", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "next.pageToken", "value": "", "type": "query", "description": "Page Token" }, { "name": "next.orderBy", "value": "", "type": "query", "description": "OrderBy helps in sorting the list response" }, { "name": "next.pageNum", "value": "", "type": "query", "description": "Page Number" }, { "name": "next.pageSize", "value": "", "type": "query", "description": "Defines the page size" }, { "name": "next.totalPages", "value": "", "type": "query", "description": "Total number of pages to be fetched." } ] }, "docs": "Query all realms." }, { "info": { "name": "Create a realm for an enterprise", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/realms", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create a realm. For example, zededa.com can be registered as a realm for an enterprise. Only those Oauth users who belong to this domain will be allowed to login to the enterprise." }, { "info": { "name": "Get a realm", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/realms/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the details of a realm" }, { "info": { "name": "Update a realm", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/realms/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique system defined realm ID" } ] }, "docs": "Update a realm. The usual pattern to update a realm is to retrieve the record and update with the modified values in a new body to update the realm." }, { "info": { "name": "Delete a realm", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/realms/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a realm." }, { "info": { "name": "Get IAM realm", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/realms/name/:name", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get a realm by name." }, { "info": { "name": "Query IAM Roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/roles", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "summary", "value": "", "type": "query" }, { "name": "SfdcId", "value": "", "type": "query" }, { "name": "HubspotId", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "namePattern", "value": "", "type": "query" }, { "name": "all", "value": "", "type": "query" }, { "name": "roleName", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "next.pageToken", "value": "", "type": "query", "description": "Page Token" }, { "name": "next.orderBy", "value": "", "type": "query", "description": "OrderBy helps in sorting the list response" }, { "name": "next.pageNum", "value": "", "type": "query", "description": "Page Number" }, { "name": "next.pageSize", "value": "", "type": "query", "description": "Defines the page size" }, { "name": "next.totalPages", "value": "", "type": "query", "description": "Total number of pages to be fetched." } ] }, "docs": "Query the IAM Role records." }, { "info": { "name": "Create IAM role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/roles", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create an IAM role record." }, { "info": { "name": "Get IAM role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/roles/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) of an IAM role record." }, { "info": { "name": "Update IAM role", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/roles/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique system defined role ID" } ] }, "docs": "Update an IAM role record. The usual pattern to update an IAM role record is to retrieve the record and update with the modified values in a new body to update the IAM role record." }, { "info": { "name": "Delete IAM role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/roles/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an IAM role record." }, { "info": { "name": "Get IAM role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/roles/name/:name", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) of an IAM role record." }, { "info": { "name": "Get own IAM role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/roles/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Get the configuration (without security details) of user's own IAM role record." }, { "info": { "name": "Query user sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sessions", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Query all the active user sessions for all users." }, { "info": { "name": "Refresh current user session", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/sessions/refresh", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Refresh the current user session. The current session will be extended for another 4 hours." }, { "info": { "name": "Get current user session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sessions/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Get the details of the current user session." }, { "info": { "name": "Get user session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sessions/token", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "sessionToken.base64", "value": "", "type": "query" } ] }, "docs": "Get the details of a user session with given session token." }, { "info": { "name": "Generate a new session token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/sessions/token/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Generate a new token with an extended expiry time. The desired expiry time should be passed as number of seconds." }, { "info": { "name": "Get user session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sessions/token/:sessionToken.base64", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "sessionToken.base64", "value": "", "type": "path" } ] }, "docs": "Get the details of a user session with given session token." }, { "info": { "name": "Query IAM users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/users", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "summary", "value": "", "type": "query" }, { "name": "SfdcId", "value": "", "type": "query" }, { "name": "HubspotId", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "namePattern", "value": "", "type": "query" }, { "name": "all", "value": "", "type": "query" }, { "name": "roleName", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "next.pageToken", "value": "", "type": "query", "description": "Page Token" }, { "name": "next.orderBy", "value": "", "type": "query", "description": "OrderBy helps in sorting the list response" }, { "name": "next.pageNum", "value": "", "type": "query", "description": "Page Number" }, { "name": "next.pageSize", "value": "", "type": "query", "description": "Defines the page size" }, { "name": "next.totalPages", "value": "", "type": "query", "description": "Total number of pages to be fetched." } ] }, "docs": "Query the IAM user records." }, { "info": { "name": "Create IAM user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/users", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Create an IAM user record." }, { "info": { "name": "Get IAM user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/users/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) of an IAM user record." }, { "info": { "name": "Update IAM user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/users/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique system defined user ID" } ] }, "docs": "Update an IAM user record. The usual pattern to update an IAM user record is to retrieve the record and update with the modified values in a new body to update the IAM user record." }, { "info": { "name": "Delete IAM user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/users/id/:id", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an IAM user record." }, { "info": { "name": "Get IAM user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/users/name/:name", "headers": [ { "name": "X-Request-Id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get the configuration (without security details) of an IAM user record." }, { "info": { "name": "Get own IAM user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/users/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Get the configuration (without security details) of user's own IAM user record." }, { "info": { "name": "Update IAM user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/users/self", "headers": [ { "name": "X-Request-Id", "value": "" } ] }, "docs": "Update an IAM user record. The usual pattern to update an IAM user record is to retrieve the record and update with the modified values in a new body to update the IAM user record." } ] } ], "bundled": true }