{"swagger":"2.0","info":{"description":"Provides API to manage Security in DPM","version":"1.0.0","title":"Security RESTful API"},"basePath":"/security/rest","tags":[{"name":"security"}],"paths":{"/v1/blacklistedDomains":{"get":{"tags":["security"],"summary":"Get blacklisted domains","description":"","operationId":"getBlacklistedDomains","produces":["application/json"],"parameters":[{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"filterText","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}},"put":{"tags":["security"],"summary":"Create blacklisted domain","description":"","operationId":"createBlacklistedDomain","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BlacklistedDomainJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BlacklistedDomainJson"}}}}},"/v1/blacklistedDomains/{id}":{"delete":{"tags":["security"],"summary":"Delete blacklisted domain","description":"","operationId":"deleteBlacklistedDomain","consumes":["application/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/componentTypes":{"get":{"tags":["security"],"summary":"Returns Component Types","description":"","operationId":"getComponentTypes","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ComponentTypeJson"}}}}}},"/v1/componentVersionRange":{"get":{"tags":["security"],"summary":"Get Component Version Range for argument component Id","description":"","operationId":"getComponentVersionRange","produces":["application/json"],"parameters":[{"name":"id","in":"query","required":false,"type":"string","default":"dc"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComponentVersionRangeJson"}}}},"post":{"tags":["security"],"summary":"Update Component Version Range","description":"","operationId":"updateComponentVersionRange","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ComponentVersionRangeJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComponentVersionRangeJson"}}}}},"/v1/organization/{orgId}/api-user-credentials":{"get":{"tags":["security"],"summary":"List API User Credentials for the current user","description":"","operationId":"listApiCredentials","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiCredentialsJson"}}}},"post":{"tags":["security"],"summary":"Create an API User Credentials","description":"","operationId":"createApiUserCredentials","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ApiCredentialsRequestJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiCredentialsJson"}}}}},"/v1/organization/{orgId}/api-user-credentials-for-org":{"get":{"tags":["security"],"summary":"List API User Credentials for the organization","description":"","operationId":"listApiCredentialsForOrg","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"userId","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiCredentialsJson"}}}}},"/v1/organization/{orgId}/components/delete":{"post":{"tags":["security"],"summary":"Delete Components for all given list of components IDs","description":"","operationId":"deleteRegisteredComponents","consumes":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/components/regenerateAuthToken":{"post":{"tags":["security"],"summary":"Regenerate Auth Token for all given list of component IDs","description":"","operationId":"regenerateAuthToken","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ComponentJson"}}}}}},"/v1/organization/{orgId}/components":{"get":{"tags":["security"],"summary":"Get all registered components for given Organization ID","description":"","operationId":"getOrganizationComponents","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"componentTypeId","in":"query","required":false,"type":"string","default":"dc"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"LAST_VALIDATED_ON","enum":["ID","REGISTERED_ON","LAST_VALIDATED_ON"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ComponentJson"}}}}},"put":{"tags":["security"],"summary":"Create Components for given Organization ID","description":"","operationId":"createComponents","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewComponentsJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ComponentJson"}}}}}},"/v1/organization/{orgId}/api-user-credentials/{credentialsId}":{"post":{"tags":["security"],"summary":"Update an API User Credentials","description":"","operationId":"updateApiUserCredentials","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"credentialsId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ApiCredentialsRequestJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiCredentialsJson"}}}},"delete":{"tags":["security"],"summary":"Delete an API User Credentials","description":"","operationId":"deleteApiUserCredentials","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"credentialsId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiCredentialsJson"}}}}},"/v1/organization/{orgId}/components/nonRegistered":{"get":{"tags":["security"],"summary":"Get count of non registered components for given Organization ID","description":"","operationId":"getNonRegisteredComponents","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v1/organization/{orgId}/components/deleteNonRegistered/{type}":{"post":{"tags":["security"],"summary":"Delete Non-registered Components for give component type for given Organization ID","description":"","operationId":"deleteNonRegisteredComponents","parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"type","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/components/activate":{"post":{"tags":["security"],"summary":"Activate Components for all given Component IDs","description":"","operationId":"activateComponents","consumes":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/components/deactivate":{"post":{"tags":["security"],"summary":"Deactivate Components for all given Component IDs","description":"","operationId":"deactivateComponents","consumes":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ComponentJson"}}}}}},"/v1/project/{projectId}":{"get":{"tags":["security"],"summary":"Returns a Project","description":"","operationId":"getContainer","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProjectJson"}}}},"post":{"tags":["security"],"summary":"Updates a Project","description":"","operationId":"updateContainer","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ProjectJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProjectJson"}}}}},"/v1/project/{projectId}/getAllUsersWithGroups":{"get":{"tags":["security"],"summary":"Returns all users assigned to the project including group memberships","description":"","operationId":"getAllUsersOfContainerWithGroups","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"active","in":"query","required":false,"type":"boolean"},{"name":"orderBy","in":"query","required":false,"type":"string","enum":["ID","NAME","ID_OR_NAME","CREATED_ON","CREATOR","LAST_MODIFIED_ON","LAST_MODIFIED_BY","EXTERNAL_ID","DISPLAY_NAME","EXCLUDE_ALL"]},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserJson"}}}}}},"/v1/project/{projectId}/getAllUsers":{"get":{"tags":["security"],"summary":"Returns all users assigned to the project","description":"","operationId":"getUsersByContainer","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"active","in":"query","required":false,"type":"boolean"},{"name":"orderBy","in":"query","required":false,"type":"string","enum":["ID","NAME","ID_OR_NAME","CREATED_ON","CREATOR","LAST_MODIFIED_ON","LAST_MODIFIED_BY","EXTERNAL_ID","DISPLAY_NAME","EXCLUDE_ALL"]},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserJson"}}}}}},"/v1/project/{projectId}/users":{"put":{"tags":["security"],"summary":"Synchronizes the users assigned to the project.","description":"","operationId":"updateUsersForContainer","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/UpdateProjectUserRequest"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/project/{projectId}/groups":{"put":{"tags":["security"],"summary":"Synchronizes the groups assigned to the project.","description":"","operationId":"updateGroupsForContainer","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/UpdateProjectGroupsRequest"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateProjectGroupsResponse"}}}}},"/v1/project/{projectId}/getAllGroups":{"get":{"tags":["security"],"summary":"Returns all groups assigned to the project","description":"","operationId":"getGroupsByContainer","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"NAME","enum":["ID","NAME","ID_OR_NAME","CREATED_ON","CREATOR","LAST_MODIFIED_ON","LAST_MODIFIED_BY","EXTERNAL_ID","DISPLAY_NAME","EXCLUDE_ALL"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"filterText","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Group"}}}}}},"/v1/projects":{"get":{"tags":["security"],"summary":"Returns Projects that the current user has access to","description":"","operationId":"getContainers","produces":["application/json"],"parameters":[{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"filterText","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ProjectJson"}}}}},"post":{"tags":["security"],"summary":"Creates a project","description":"","operationId":"createContainer","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewProject"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProjectJson"}}}},"put":{"tags":["security"],"summary":"Deletes projects","description":"","operationId":"deleteContainers","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DeleteProjectsRequest"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeleteProjectsResponse"}}}}},"/v1/projects/search":{"get":{"tags":["security"],"summary":"Searches for projects using Advanced Query Language (RSQL support)","description":"","operationId":"searchContainers","produces":["application/json"],"parameters":[{"name":"search","in":"query","required":false,"type":"string"},{"name":"orderBy","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":0,"format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ProjectJson"}}}}}},"/v1/currentUser":{"get":{"tags":["security"],"summary":"Get Current User","description":"","operationId":"getCurrentUser","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SSOPrincipalJson"}}}}},"/v1/currentUser/passwordStatus":{"get":{"tags":["security"],"summary":"Get Current User Password status","description":"","operationId":"getPasswordStatus","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PasswordStatusJson"}}}}},"/v1/currentUser/contactProvider":{"post":{"tags":["security"],"summary":"Contact this DPM instance provider","description":"","operationId":"contactProvider","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"string"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/currentUser/availableAddOns":{"get":{"tags":["security"],"summary":"Get list of available and unavailable addons for this user","description":"","operationId":"getAvailableAddOns","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/deployment/{orgId}/{deploymentId}/deploymentToken":{"post":{"tags":["security"],"summary":"Create Deployment token for given Deployment ID","description":"","operationId":"createDeploymentToken","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"deploymentId","in":"path","required":true,"type":"string"},{"name":"containerId","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComponentJson"}}}}},"/v1/organization/deployment/{orgId}/{deploymentId}/engineTokens":{"get":{"tags":["security"],"summary":"List engine tokens for given Deployment ID","description":"","operationId":"listEngineTokensForDeployment","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"deploymentId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/MinimalComponentInfoJson"}}}}}},"/v1/organization/deployment/{orgId}/{environmentId}/{agentId}/agentToken":{"post":{"tags":["security"],"summary":"Create Kubernetes Agent Token for the given Environment and Kubernetes Agent","description":"","operationId":"createKubernetesAgentToken","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"environmentId","in":"path","required":true,"type":"string"},{"name":"agentId","in":"path","required":true,"type":"string"},{"name":"containerId","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComponentJson"}}}}},"/v1/organization/deployment/{orgId}/{deploymentId}/engineToken":{"post":{"tags":["security"],"summary":"Create Engine token for given Deployment ID","description":"","operationId":"createEngineTokenForDeployment","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"deploymentId","in":"path","required":true,"type":"string"},{"name":"type","in":"query","required":false,"type":"string","default":"dc"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComponentJson"}}}}},"/v1/organization/deployment/{orgId}/{deploymentId}/{engineId}":{"post":{"tags":["security"],"summary":"Validate engine token for given Deployment ID and Engine ID, returning a new one if needed","description":"","operationId":"validateEngineTokenForDeploymentAndEngine","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"deploymentId","in":"path","required":true,"type":"string"},{"name":"engineId","in":"path","required":true,"type":"string"},{"name":"type","in":"query","required":false,"type":"string","default":"dc"},{"in":"body","name":"body","required":false,"schema":{"type":"string"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComponentJson"}}}}},"/v1/ldap":{"get":{"tags":["security"],"summary":"Check if LDAP is enabled","description":"","operationId":"isLdapEnabled","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"boolean"}}}}},"/v1/metrics/{orgId}/notLoggedInUsers":{"get":{"tags":["security"],"summary":"Get all users with no login activity between start time and end time","description":"","operationId":"getAllUsersWithNoLoginActivityForOrgFilteredByTime","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":100,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"createdOn"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"group","in":"query","required":false,"type":"string"},{"name":"startTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","format":"int64"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJsonListUserJson"}}}}},"/v1/metrics/{orgId}/loggedInUsers":{"get":{"tags":["security"],"summary":"Get all users with login activity between start time and end time","description":"","operationId":"getAllUsersWithLoginActivityForOrgFilteredByTime","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":100,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"createdOn"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"group","in":"query","required":false,"type":"string"},{"name":"startTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","format":"int64"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJsonListUserJson"}}}}},"/v1/metrics/{orgId}/actionAudits":{"get":{"tags":["security"],"summary":"Get all action audits between start time and end time","description":"","operationId":"getUserActionsForOrgFilteredByTime","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":100,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"time"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"startTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","format":"int64"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJsonListUserActionAuditJson"}}}}},"/v1/metrics/{orgId}/usersCreated":{"get":{"tags":["security"],"summary":"Get all users created between start time and end time","description":"","operationId":"listUsersCreatedForOrgFilteredByTime","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"group","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":100,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"createdOn"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"startTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","format":"int64"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJsonListUserJson"}}}}},"/v1/metrics/{orgId}/usersNotInGroup":{"get":{"tags":["security"],"summary":"Get all users that don't belong to group specified","description":"","operationId":"listUsersNotInGroupForOrgFilteredByTime","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":100,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"createdOn"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"group","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJsonListUserJson"}}}}},"/v1/metrics/{orgId}/loginAudits":{"get":{"tags":["security"],"summary":"Get all login audits between start time and end time","description":"","operationId":"listLoginsForOrgFilteredByTime","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":100,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"loginTimestamp"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"startTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","format":"int64"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJsonListLoginAuditJson"}}}}},"/v1/organizationConfig/{orgId}":{"get":{"tags":["security"],"summary":"Get Organization configuration for given Organization ID","description":"","operationId":"getOrganizationConfigs","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationConfigContainerJson"}}}},"post":{"tags":["security"],"summary":"Update Organization configuration for given Organization ID","description":"","operationId":"updateOrganizationConfigurations","consumes":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrganizationConfigContainerJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/configs":{"get":{"tags":["security"],"summary":"DEPRECATED in favor of /v1/organizationConfig: Get Organization configuration for given Organization ID","description":"","operationId":"getOrganizationConfigs_1","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"deprecated":true,"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson"}}}}},"post":{"tags":["security"],"summary":"DEPRECATED in favor of /v1/organizationConfig: Update Organization configuration for given Organization ID","description":"","operationId":"updateOrganizationConfigurations_1","consumes":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson","entity":"OrganizationConfigJson"}}}],"security":[{"basic":[]}],"deprecated":true,"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/users/count":{"get":{"tags":["security"],"summary":"Get User Count","description":"","operationId":"getOrgUsersCount","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v1/organization/{orgId}/user/{userId}/listActions":{"get":{"tags":["security"],"summary":"Get user actions done for given user ID","description":"","operationId":"listUserActionsForUser","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"TIME","enum":["TIME","ACTION","REQUESTER_ID","AFFECTS_USER"]},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserActionAuditJson"}}}}}},"/v1/organization/{orgId}/user/{userId}/listActionsRequested":{"get":{"tags":["security"],"summary":"Get user actions requested by given user ID","description":"","operationId":"listUserActionsRequestedByUser","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"TIME","enum":["TIME","ACTION","REQUESTER_ID","AFFECTS_USER"]},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserActionAuditJson"}}}}}},"/v1/organization/{orgId}/users/listActions":{"get":{"tags":["security"],"summary":"Get all user actions for given Organization ID","description":"","operationId":"listUserActionsForOrg","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"TIME","enum":["TIME","ACTION","REQUESTER_ID","AFFECTS_USER"]},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserActionAuditJson"}}}}}},"/v1/organization/{orgId}/groups/delete":{"post":{"tags":["security"],"summary":"Delete Groups for all given Group IDs","description":"","operationId":"deleteGroups","consumes":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/samlIdp":{"get":{"tags":["security"],"summary":"Get IdP configuration for an Organization","description":"","operationId":"getOrganizationIdpConfiguration","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationExternalAuthJson"}}}},"post":{"tags":["security"],"summary":"Update IdP configuration for an Organization","description":"","operationId":"updateOrganizationIdpConfiguration","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrganizationExternalAuthJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationExternalAuthJson"}}}}},"/v1/organization/{orgId}/user/{userId}":{"get":{"tags":["security"],"summary":"Get User for given User ID and Organization ID","description":"","operationId":"getUser","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserJson"}}}},"post":{"tags":["security"],"summary":"Update User for given User ID and Organization ID","description":"","operationId":"updateUser","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/UserJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserJson"}}}}},"/v1/organization/{orgId}":{"get":{"tags":["security"],"summary":"Get Organization for given Organization ID","description":"","operationId":"getOrganization","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationJson"}}}},"post":{"tags":["security"],"summary":"Update Organization for given Organization ID","description":"","operationId":"updateOrganization","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrganizationJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationJson"}}}},"delete":{"tags":["security"],"summary":"Delete Organization for given Organization ID","description":"","operationId":"deleteOrganization","parameters":[{"name":"orgId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/groups":{"get":{"tags":["security"],"summary":"Get all groups for given Organization ID","description":"","operationId":"getOrganizationGroups","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"ID","enum":["ID","NAME","ID_OR_NAME","CREATED_ON","CREATOR","LAST_MODIFIED_ON","LAST_MODIFIED_BY","EXTERNAL_ID","DISPLAY_NAME","EXCLUDE_ALL"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"deleted","in":"query","required":false,"type":"boolean","default":false},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Group"}}}}},"put":{"tags":["security"],"summary":"Create Group","description":"","operationId":"createGroup","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GroupJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupJson"}}}}},"/v1/organization/{orgId}/group/{groupId}":{"get":{"tags":["security"],"summary":"Get Group for given Group ID and Organization ID","description":"","operationId":"getGroup","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"groupId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupJson"}}}},"post":{"tags":["security"],"summary":"Update Group for given Group ID and Organization ID","description":"","operationId":"updateGroup","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"groupId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GroupJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupJson"}}}},"delete":{"tags":["security"],"summary":"Delete Group for given Group ID and Organization ID","description":"","operationId":"deleteGroup","parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"groupId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organization/{orgId}/users":{"get":{"tags":["security"],"summary":"Get all Users for given Organization ID","description":"","operationId":"getOrganizationUsers","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"ID","enum":["ID","NAME","CREATED_ON","CREATOR","LAST_MODIFIED_ON","LAST_MODIFIED_BY","EMAIL","EXPIRY_TIME"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"active","in":"query","description":"Filter by active status: Specify 'true' to retrieve only active users, 'false' to retrieve only inactive users, or 'none' to ignore the active status of users. If 'filterText' is provided, and 'active' is not explicitly specified, the default behavior is to return only active users.","required":false,"type":"string"},{"name":"expiry","in":"query","required":false,"type":"integer","default":0,"format":"int64"},{"name":"deleted","in":"query","required":false,"type":"boolean","default":false},{"name":"fetchGroups","in":"query","required":false,"type":"boolean","default":true},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserJson"}}}}}},"/v1/organization/{orgId}/user/{userId}/listLogins":{"get":{"tags":["security"],"summary":"List audit logs for user logins for given User ID and Organization ID","description":"","operationId":"listLoginsForUser","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"loginTimestamp"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LoginAuditJson"}}}}}},"/v1/organization/{orgId}/users/listLogins":{"get":{"tags":["security"],"summary":"List audit logs for all user logins in the organization for given Organization ID","description":"","operationId":"listLoginsForOrg","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"loginTimestamp"},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LoginAuditJson"}}}}}},"/v1/organizations/expireFreeTrial":{"post":{"tags":["security"],"summary":"Expire Free Trial Orgs","description":"","operationId":"expireFreeTrialOrganizations","consumes":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organizations/delete":{"post":{"tags":["security"],"summary":"Delete Organizations for all given Organization IDs","description":"","operationId":"deleteOrganizations","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organizations/globalConfigs":{"get":{"tags":["security"],"summary":"Get Organizations global configurations","description":"","operationId":"getGlobalOrganizationConfigs","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson"}}}}},"post":{"tags":["security"],"summary":"Update Organization global configurations","description":"","operationId":"updateGlobalOrganizationConfigs","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson","entity":"OrganizationConfigJson"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/organizations":{"get":{"tags":["security"],"summary":"Get all organizations","description":"","operationId":"getOrganizations","produces":["application/json"],"parameters":[{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"ID","enum":["ID","NAME","CREATED_ON","CREATOR","LAST_MODIFIED_ON","LAST_MODIFIED_BY","PRIMARY_ADMIN_ID"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"active","in":"query","required":false,"type":"boolean"},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationJson"}}}}},"put":{"tags":["security"],"summary":"Create new organization","description":"","operationId":"createOrganization","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewOrganizationJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationJson"}}}}},"/v1/organizations/count":{"get":{"tags":["security"],"summary":"Get Organizations Count","description":"","operationId":"getOrganizationsCount","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"active","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v1/organizations/globalSamlIdpConfigs":{"get":{"tags":["security"],"summary":"Get Organizations global IdP configurations","description":"","operationId":"getDefaultOrganizationIdpConfigs","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson"}}}}},"post":{"tags":["security"],"summary":"Update Organization global IdP configurations","description":"","operationId":"updateDefaultOrganizationIdpConfigs","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson","entity":"OrganizationConfigJson"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/roles":{"get":{"tags":["security"],"summary":"Get all available User Roles","description":"","operationId":"getRoles","produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RoleJson"}}}}}},"/v1/sessions/{orgId}/active":{"get":{"tags":["security"],"summary":"Get all active user sessions for given Organization ID","description":"","operationId":"getActiveSessions","produces":["application/json"],"parameters":[{"name":"orgId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"EXPIRY_TIME","enum":["USER_ID","ORG_ID","EXPIRY_TIME","LAST_ACTIVITY","LAST_ACTIVITY_IP"]},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC","enum":["ASC","DESC"]},{"name":"withWrapper","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserSessionJson"}}}}}},"/v1/sessions/delete":{"post":{"tags":["security"],"summary":"Delete Active Session for all given Session IDs","description":"","operationId":"logoutSessions","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/validateAuthToken/user":{"post":{"tags":["security"],"summary":"Validate User Auth Token","description":"","operationId":"validateUser","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ValidateUserAuthTokenJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SSOPrincipalJson"}}}}},"/v1/validateAuthToken/component":{"post":{"tags":["security"],"summary":"Validate Component Auth token","description":"","operationId":"validateComponent","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ValidateComponentAuthTokenJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SSOPrincipalJson"}}}}}},"definitions":{"PaginationWrapperJson":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"len":{"type":"integer","format":"int64"},"data":{"type":"object"}}},"BlacklistedDomainJson":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"reason":{"type":"string"}}},"ComponentTypeJson":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"ComponentVersionRangeJson":{"type":"object","properties":{"id":{"type":"string"},"componentMinVersion":{"type":"string"},"componentMaxVersion":{"type":"string"},"componentMinBuildDate":{"type":"string"}}},"ApiCredentialsJson":{"type":"object","properties":{"label":{"type":"string"},"userId":{"type":"string"},"registeredBy":{"type":"string"},"componentId":{"type":"string"},"authToken":{"type":"string"},"active":{"type":"boolean"}}},"ComponentJson":{"type":"object","properties":{"fullAuthToken":{"type":"string"},"authTokenGeneratedOn":{"type":"integer","format":"int64"},"organization":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"registeredOn":{"type":"integer","format":"int64"},"registeredBy":{"type":"string"},"type":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"lastValidatedOn":{"type":"integer","format":"int64"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"attributesUpdatedOn":{"type":"integer","format":"int64"},"projectId":{"type":"string"}}},"NewComponentsJson":{"type":"object","properties":{"organization":{"type":"string"},"componentType":{"type":"string"},"numberOfComponents":{"type":"integer","format":"int32"},"active":{"type":"boolean"}}},"ApiCredentialsRequestJson":{"type":"object","properties":{"label":{"type":"string"},"active":{"type":"boolean"},"generateAuthToken":{"type":"boolean"},"userId":{"type":"string"}}},"ProjectJson":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"membersCount":{"type":"integer","format":"int32"}}},"UserJson":{"type":"object","properties":{"id":{"type":"string"},"organization":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"passwordExpiryTime":{"type":"integer","format":"int64"},"creator":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"destroyer":{"type":"string"},"deleteTime":{"type":"integer","format":"int64"},"userDeleted":{"type":"boolean"},"nameInOrg":{"type":"string"},"migrationAliases":{"type":"array","items":{"type":"string"}},"projectRoles":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"passwordGenerated":{"type":"boolean"}}},"UpdateProjectUserRequest":{"type":"object","properties":{"userIds":{"type":"array","description":"List of user IDs to synchronize.","uniqueItems":true,"items":{"type":"string"}}}},"UpdateProjectGroupsResponse":{"type":"object","properties":{"addedGroupIds":{"type":"array","description":"List of group IDs added after synchronizing.","uniqueItems":true,"items":{"type":"string"}},"deletedGroupIds":{"type":"array","description":"List of group IDs deleted after synchronizing.","uniqueItems":true,"items":{"type":"string"}}}},"UpdateProjectGroupsRequest":{"type":"object","properties":{"groupIds":{"type":"array","description":"List of group IDs to synchronize.","uniqueItems":true,"items":{"type":"string"}}}},"Component":{"type":"object","properties":{"internalId":{"type":"string"},"authTokenHash":{"type":"string"},"authToken":{"type":"string"},"authTokenGeneratedOn":{"type":"integer","format":"int64"},"organization":{"$ref":"#/definitions/Organization"},"active":{"type":"boolean"},"id":{"type":"string"},"containerId":{"type":"string"},"registeredBy":{"type":"string"},"owner":{"type":"string"},"registeredOn":{"type":"integer","format":"int64"},"type":{"$ref":"#/definitions/ComponentType"},"label":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/definitions/Role"}},"groups":{"type":"array","items":{"type":"string"}},"lastValidatedOn":{"type":"integer","format":"int64"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"attributesUpdatedOn":{"type":"integer","format":"int64"},"lastModifiedOn":{"type":"integer","format":"int64"},"optimisticLockVersion":{"type":"integer","format":"int64"},"fullAuthToken":{"type":"string"}}},"ComponentType":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"defaultRoles":{"type":"array","items":{"$ref":"#/definitions/Role"}},"optimisticLockVersion":{"type":"integer","format":"int64"}}},"Group":{"type":"object","properties":{"optimisticLockVersion":{"type":"integer","format":"int64"},"id":{"type":"string"},"externalId":{"type":"string"},"organization":{"$ref":"#/definitions/Organization"},"predefined":{"type":"boolean"},"name":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Role"}},"creator":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"users":{"type":"array","items":{"$ref":"#/definitions/User"}},"destroyer":{"type":"string"},"deleteTime":{"type":"integer","format":"int64"},"groupDeleted":{"type":"boolean"},"externalGroupIds":{"type":"array","items":{"type":"string"}},"projectRoles":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Role"}}}},"Organization":{"type":"object","properties":{"optimisticLockVersion":{"type":"integer","format":"int64"},"id":{"type":"string"},"predefined":{"type":"boolean"},"name":{"type":"string"},"creator":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"primaryAdmin":{"$ref":"#/definitions/User"},"users":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"groups":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Group"}},"components":{"type":"array","items":{"$ref":"#/definitions/Component"}},"active":{"type":"boolean"},"passwordExpiryTimeInMillis":{"type":"integer","format":"int64"},"validDomains":{"type":"string"},"organizationCustomConfigs":{"type":"object","additionalProperties":{"type":"string"}},"externalAuthEnabled":{"type":"boolean"},"configs":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfig"}}}},"OrganizationConfig":{"type":"object","properties":{"optimisticLockVersion":{"type":"integer","format":"int64"},"id":{"type":"string"},"configType":{"type":"string"},"name":{"type":"string"},"orgModifiable":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"},"dependsOnConfig":{"type":"string"},"dependsOnValue":{"type":"string"},"defaultValue":{"type":"string"},"secret":{"type":"boolean"},"orgConfigProperty":{"type":"string","enum":["SECURITY_INACTIVITY_SESSION_TERMINATION_MINS","SECURITY_PASSWORD_CHANGE_INTERVAL_DAYS","SECURITY_MAX_ORGANIZATION_USERS","SECURITY_MAX_ORGANIZATION_GROUPS","SECURITY_MAX_ORGANIZATION_DATA_COLLECTORS","SECURITY_MAX_ORGANIZATION_PROVISIONING_AGENTS","SECURITY_DISABLE_SAML_BACKDOOR","SECURITY_DISABLE_API_OFFSET_LEN_CHECKS","ENABLE_JOB_RUNNER_1","ENABLE_JOB_RUNNER_2","ENABLE_JWT_FOR_USER_LOGIN_AUTHENTICATION","JOBRUNNER_MAX_ORGANIZATION_JOBS","JOBRUNNER_MAX_JOB_RUNS","JOBRUNNER_ORG_DATABASE_CONNECTIONS_LIMIT","JOBRUNNER_JOB_STATUS_HISTORY_PURGE_DAYS","JOBRUNNER_SYSTEM_LIMIT_JOB_STATUS_HISTORY_PURGE_DAYS","JOBRUNNER_SYSTEM_LIMIT_JOB_RUNS","JOBRUNNER_START_JOB_SYNC","JOBRUNNER_FAILOVER_TIME_SECS","JOBRUNNER_FAILOVER_CLOUD_ENGINE_TIME_SECS","JOBRUNNER_SYSTEM_LIMIT_FAILOVER_TIME_SECS","JOBRUNNER_MAX_RUNNING_JOBS","JOBRUNNER_EXTRACT_JOB_CREATION_COUNT","JOBRUNNER_CACHE_NUM_JOBS_THRESHOLD","JOBRUNNER_SDC_ACK_TIMEOUT","DRAFT_RUN_JOBS_ONLY_FOR_NEWER_ENGINES","JOBRUNNER_ALLOW_ENGINE_CONFIGS","PIPELINESTORE_MAX_ORGANIZATION_PIPELINES","PIPELINESTORE_MAX_ORGANIZATION_PIPELINE_COMMITS","TOPOLOGY_MAX_ORGANIZATION_TOPOLOGIES","TOPOLOGY_MAX_ORGANIZATION_TOPOLOGY_COMMITS","TIMESERIES_METRICS_PURGE_DAYS","TIMESERIES_SYSTEM_LIMIT_METRICS_PURGE_DAYS","PROVISIONING_MAX_ORGANIZATION_CSP_ENVIRONMENTS","PROVISIONING_MAX_ORGANIZATION_CSP_DEPLOYMENTS","PROVISIONING_MAX_ORGANIZATION_DEPLOYMENTS","PROVISIONING_MAX_ORGANIZATION_CSP_KUBERNETES_AGENTS","ENABLE_LEGACY_KUBERNETES_INTEGRATION","ALLOWED_ENVIRONMENT_TYPES","PROVISIONING_DEFAULT_SELF_ENVIRONMENT_FEATURE_VERSION","PROVISIONING_DEFAULT_AWS_ENVIRONMENT_FEATURE_VERSION","PROVISIONING_DEFAULT_GCP_ENVIRONMENT_FEATURE_VERSION","PROVISIONING_DEFAULT_AZURE_ENVIRONMENT_FEATURE_VERSION","PROVISIONING_DEFAULT_KUBERNETES_ENVIRONMENT_FEATURE_VERSION","PROVISIONING_ENABLE_HOSTED_ENVIRONMENT","PROVISIONING_SHOW_STAGE_LIB_MODE_UI","ENFORCE_PERMISSIONS","ORG_CONFIG_ACCOUNT_TYPE","ORG_CONFIG_TRIAL_EXPIRATION_TIME","ORG_CONFIG_CONTRACT_EXPIRATION_TIME","ENABLE_SERVICE_ACCOUNTS","ENABLE_EVENTS","ENABLE_SYSTEM_DATA_COLLECTOR","ENABLE_TIME_SERIES_ANALYSIS","ENABLE_COLLECTOR","ENABLE_TRANSFORMER","ENABLE_SNOWPARK","SYS_ADMIN_SNOWPARK_PREVIEW_OVERRIDE","ENABLE_SNOWPARK_PREVIEW","ENABLE_SNOWPARK_DEBUGGING","SNOWPARK_HOSTED_ENGINE","ENABLE_DATA_PLANE_UPGRADES","NOTIFICATION_MAX_ORGANIZATION_SUBSCRIPTIONS","SYS_ADMIN_TUNNELING_OVERRIDE","ENABLE_TUNNELING","SYS_ADMIN_TUNNELING_ATTACHMENT_DOWNLOAD_OVERRIDE","SCHEDULER_SYSTEM_ENABLE_SCHEDULER_PURGE","SCHEDULER_MAX_SCHEDULER_RUNS","SCHEDULER_SYSTEM_LIMIT_MAX_SCHEDULER_RUNS","SCHEDULER_MAX_SCHEDULER_RUNS_TIME_DAYS","SCHEDULER_SYSTEM_LIMIT_MAX_SCHEDULER_RUNS_TIME_DAYS","SCHEDULER_MAX_RUNNING_JOBS","MAX_API_USER_CREDENTIALS_PER_USER","ENABLE_SDC_CLUSTER_MODE","SHOW_DEPRECATED_STAGES","DISABLED_ENGINE_VERSION_OVERRIDE_LIST","IMPORTER_ENABLED","ADVANCED_QUERY_MAX_RECORDSET_SIZE","METERING_ENABLED","ENGINE_METERING_REPORT_PATH","ENGINE_METERING_REPORT_INTERVAL","METERING_UI_ENABLED","ORG_CONFIG_ENABLE_ACL_AUDIT_PURGE","AQL_MAX_USER_SEARCHES","AQL_HISTORIC_STAGE_PROCESSING_ENABLED","IDP_SCIM_ENABLED","IDP_URI","IDP_ORGANIZATION_NAME","IDP_ORGANIZATION_URL","IDP_ORGANIZATION_DISPLAY_NAME","IDP_ASSERTION_USERNAME","IDP_ENCRYPTION_ALGORITHM","IDP_LANDING_URL","IDP_POST_SSO_URL","IDP_REDIRECT_SSO_URL","IDP_REQUEST_AUTHN_CONTEXT_CLASS","IDP_REQUESTED_AUTHN_CONTEXT_COMPARISON","IDP_SIGNATURE_ALGORITHM","IDP_SIGNATURE_CREDENTIAL_PUBLIC_KEY_PEMS_0","IDP_SUPPORT_EMAIL","IDP_WANTS_ASSERTION_ENCRYPTED","IDP_WANTS_ASSERTION_SIGNED","IDP_WANTS_MESSAGE_SIGNED","FREE_TRIAL_EXPIRATION_TIME","ENGINE_REACHABILITY_TIMEOUT","IP_AUTH_EDIT_AVAILABLE_TO_ORG_ADMIN","IBM_DATABAND_ENABLED","IBM_DATABAND_URL","IBM_DATABAND_TOKEN","ORG_LEVEL_PROJECTS_FEATURE_ENABLED_ON_THIS_ORG","PROVISIONING_CONTAINER_REGISTRY"]}}},"Role":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"requiredRoles":{"type":"array","items":{"type":"string"}},"admin":{"type":"boolean"},"userRole":{"type":"boolean"},"optimisticLockVersion":{"type":"integer","format":"int64"}}},"User":{"type":"object","properties":{"optimisticLockVersion":{"type":"integer","format":"int64"},"id":{"type":"string"},"organization":{"$ref":"#/definitions/Organization"},"predefined":{"type":"boolean"},"name":{"type":"string"},"email":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Role"}},"active":{"type":"boolean"},"passwordHash":{"type":"string"},"passwordExpiryTime":{"type":"integer","format":"int64"},"creator":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"destroyer":{"type":"string"},"deleteTime":{"type":"integer","format":"int64"},"userDeleted":{"type":"boolean"},"groups":{"type":"array","items":{"$ref":"#/definitions/Group"}},"nameInOrg":{"type":"string"},"passwordResetTokenHash":{"type":"string"},"passwordResetTokenExpiryTime":{"type":"integer","format":"int64"},"migrationAliases":{"type":"array","items":{"type":"string"}},"projectRoles":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Role"}},"admin":{"type":"boolean"},"passwordGenerated":{"type":"boolean"}}},"NewProject":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}},"DeleteProjectsResponse":{"type":"object","properties":{"deletedProjectIds":{"type":"array","description":"List of project IDs deleted.","uniqueItems":true,"items":{"type":"string"}}}},"DeleteProjectsRequest":{"type":"object","properties":{"projectIds":{"type":"array","description":"List of project IDs to delete.","uniqueItems":true,"items":{"type":"string"}}}},"SSOPrincipalJson":{"type":"object","properties":{"tokenStr":{"type":"string"},"issuerUrl":{"type":"string"},"expires":{"type":"integer","format":"int64"},"principalId":{"type":"string"},"principalName":{"type":"string"},"organizationId":{"type":"string"},"organizationName":{"type":"string"},"email":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"groups":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"app":{"type":"boolean"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"containerId":{"type":"string"},"filteredEntityManagerEnabled":{"type":"boolean"}}},"PasswordStatusJson":{"type":"object","properties":{"firstLogin":{"type":"boolean"},"passwordExpired":{"type":"boolean"},"passwordGenerated":{"type":"boolean"}}},"MinimalComponentInfoJson":{"type":"object","properties":{"id":{"type":"string"},"organization":{"type":"string"},"authTokenGeneratedOn":{"type":"integer","format":"int64"},"registeredOn":{"type":"integer","format":"int64"},"registeredBy":{"type":"string"},"active":{"type":"boolean"},"type":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"lastValidatedOn":{"type":"integer","format":"int64"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"attributesUpdatedOn":{"type":"integer","format":"int64"}}},"PaginationWrapperJsonListUserJson":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"len":{"type":"integer","format":"int64"},"data":{"type":"array","items":{"$ref":"#/definitions/UserJson"}}}},"PaginationWrapperJsonListUserActionAuditJson":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"len":{"type":"integer","format":"int64"},"data":{"type":"array","items":{"$ref":"#/definitions/UserActionAuditJson"}}}},"UserActionAuditJson":{"type":"object","properties":{"id":{"type":"string"},"time":{"type":"integer","format":"int64"},"action":{"type":"string"},"fieldType":{"type":"string"},"requesterId":{"type":"string"},"affectsUser":{"type":"string"},"orgId":{"type":"string"},"ipAddress":{"type":"string"},"oldValue":{"type":"object"},"newValue":{"type":"object"}}},"LoginAuditJson":{"type":"object","properties":{"userId":{"type":"string"},"loginTimestamp":{"type":"integer","format":"int64"},"success":{"type":"boolean"},"ipAddress":{"type":"string"},"userAgent":{"type":"string"},"logoutTimestamp":{"type":"integer","format":"int64"},"logoutUser":{"type":"string"},"logoutReason":{"type":"string"},"details":{"type":"string"}}},"PaginationWrapperJsonListLoginAuditJson":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"len":{"type":"integer","format":"int64"},"data":{"type":"array","items":{"$ref":"#/definitions/LoginAuditJson"}}}},"OrganizationConfigContainerJson":{"type":"object","properties":{"configs":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/OrganizationConfigJson"}},"ipAuthRules":{"readOnly":true,"$ref":"#/definitions/OrganizationConfigIpRuleSetJson"}}},"OrganizationConfigIpAuthRuleJson":{"type":"object","properties":{"ruleType":{"type":"string","readOnly":true,"enum":["IPV4_ALLOW"]},"address":{"type":"string","readOnly":true},"bitMask":{"type":"integer","format":"int32","readOnly":true},"comment":{"type":"string","readOnly":true}}},"OrganizationConfigIpRuleSetJson":{"type":"object","properties":{"enabled":{"type":"boolean","readOnly":true},"rules":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/OrganizationConfigIpAuthRuleJson"}}}},"OrganizationConfigJson":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgModifiable":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"},"defaultValue":{"type":"string"},"dependsOnConfig":{"type":"string"},"dependsOnValue":{"type":"string"},"possibleValues":{"type":"array","items":{"type":"string"}},"secret":{"type":"boolean"}}},"OrganizationExternalAuthJson":{"type":"object","properties":{"id":{"type":"string"},"authType":{"type":"string"},"authMetadata":{"type":"string"},"authConfigs":{"type":"array","items":{"$ref":"#/definitions/OrganizationConfigJson"}}}},"OrganizationJson":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"creator":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"primaryAdminId":{"type":"string"},"active":{"type":"boolean"},"passwordExpiryTimeInMillis":{"type":"integer","format":"int64"},"validDomains":{"type":"string"},"externalAuthEnabled":{"type":"boolean"}}},"GroupJson":{"type":"object","properties":{"id":{"type":"string"},"organization":{"type":"string"},"name":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"creator":{"type":"string"},"createdOn":{"type":"integer","format":"int64"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"users":{"type":"array","items":{"type":"string"}},"destroyer":{"type":"string"},"deleteTime":{"type":"integer","format":"int64"},"groupDeleted":{"type":"boolean"},"externalGroupIds":{"type":"array","items":{"type":"string"}},"projectRoles":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"NewOrganizationJson":{"type":"object","properties":{"organization":{"$ref":"#/definitions/OrganizationJson"},"organizationAdminUser":{"$ref":"#/definitions/UserJson"}}},"RoleJson":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"requiredRoles":{"type":"array","items":{"type":"string"}}}},"UserSessionJson":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"orgId":{"type":"string"},"expiryTime":{"type":"integer","format":"int64"},"lastActivity":{"type":"integer","format":"int64"},"lastActivityIPAddress":{"type":"string"}}},"ValidateUserAuthTokenJson":{"type":"object","properties":{"authToken":{"type":"string"},"containerId":{"type":"string"}}},"ValidateComponentAuthTokenJson":{"type":"object","properties":{"authToken":{"type":"string"},"componentId":{"type":"string"},"containerId":{"type":"string"}}}}}