v2-edge.json

{"openapi":"3.0.1","info":{"title":"Public API"},"servers":[{"url":"https://api.alero.io","description":"Generated server url"}],"security":[{"bearerScheme":[]}],"paths":{"/v2-edge/vendors/{vendorId}":{"get":{"tags":["vendors-controller-v-2"],"description":"Retrieves details of a vendor identified by ID","operationId":"getVendorById","parameters":[{"name":"vendorId","in":"path","description":"The unique ID of the vendor","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VendorResponse"}}}}}},"put":{"tags":["vendors-controller-v-2"],"description":"Updates a specific vendor's properties","operationId":"updateVendor","parameters":[{"name":"vendorId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorUpdateRequest"}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"delete":{"tags":["vendors-controller-v-2"],"description":"Deletes a vendor that is identified by ID","operationId":"deleteVendorById","parameters":[{"name":"vendorId","in":"path","description":"The unique ID of the vendor","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/vendors/{vendorId}/status":{"put":{"tags":["vendors-controller-v-2"],"description":"Updates the vendor's status","operationId":"updateVendorStatus","parameters":[{"name":"vendorId","in":"path","description":"The vendor's unique Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"The updated status of the vendor's account. Note: 'PendingActivation' is not allowed for this operation","enum":["Activated,Deactivated"]}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/users/{userId}/status":{"put":{"tags":["users-controller-v-2"],"description":"Updates the user's status","operationId":"updateUserStatus","parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"The updated status of the user's account. Note: ‘PendingActivation’ is not allowed for this operation","enum":["Deactivated,Activated"]}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/sws/users/{userId}/status":{"put":{"tags":["sws-users-controller-v-2"],"description":"Updates the user's status","operationId":"updateUserStatus_1","parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"The updated status of the user's account. Note: ‘PendingActivation’ is not allowed for this operation","enum":["Deactivated,Activated"]}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/groups/{groupId}":{"get":{"tags":["groups-controller-v-2"],"description":"Retrieves an AleroLDAP group","operationId":"getGroupById","parameters":[{"name":"groupId","in":"path","description":"The unique ID of the AleroLDAP group","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Group"}}}}}},"put":{"tags":["groups-controller-v-2"],"description":"Updates a specific AleroLDAP group.","operationId":"updateGroup","parameters":[{"name":"groupId","in":"path","description":"The unique ID of the AleroLDAP group.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The description of the AleroLDAP group"}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"delete":{"tags":["groups-controller-v-2"],"description":"Delete an AleroLDAP group by id. Note: Groups that contain members or pending invitations cannot be deleted.","operationId":"deleteGroupById","parameters":[{"name":"groupId","in":"path","description":"The unique ID of the AleroLDAP group.","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/selfServiceRequests/{id}":{"post":{"tags":["self-service-requests-controller-v-2"],"description":"Creates a vendor invitation based on a pending self-service invitation request.","operationId":"EditAndApproveSelfServiceRequest","parameters":[{"name":"id","in":"path","description":"Unique identifier of the request.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfServiceVendorInvitationRequest"}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"delete":{"tags":["self-service-requests-controller-v-2"],"description":"Rejects a pending self-service invitation request (deletes it).","operationId":"rejectSelfServiceRequest","parameters":[{"name":"id","in":"path","description":"The unique ID of the request.","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/invitations/vendor-invitations":{"post":{"tags":["invitations-controller-v-2"],"description":"Create Vendor Invitation","operationId":"createVendorInvitation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorInvitationRequest"}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"201":{"description":"Created","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/invitations/user-invitations":{"post":{"tags":["invitations-controller-v-2"],"description":"Create User Invitation","operationId":"createUserInvitation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInvitationRequest"}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"201":{"description":"Created","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/groups":{"get":{"tags":["groups-controller-v-2"],"description":"Get list of Groups","operationId":"getGroups","parameters":[{"name":"searchString","in":"query","description":"The string to use in the search","required":false,"schema":{"type":"string","default":""}},{"name":"searchIn","in":"query","description":"The field in which to perform the search","required":false,"schema":{"type":"string","default":"ALL"}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupsResponse"}}}}}},"post":{"tags":["groups-controller-v-2"],"description":"Create Group","operationId":"createGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreateRequest"}}},"required":true},"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Group"}}}}}}},"/v2-edge/vendors":{"get":{"tags":["vendors-controller-v-2"],"description":"Retrieves a list of vendors, according to a query","operationId":"getVendors","parameters":[{"name":"invitedBy","in":"query","description":"The ID of the Alero user who invited this vendor","required":false,"schema":{"pattern":"^[^()/><\\]\\[]*$","type":"string","default":""}},{"name":"searchString","in":"query","description":"The field in which to perform the search","required":false,"schema":{"pattern":"^[^()/><\\]\\[]*$","type":"string","default":""}},{"name":"searchIn","in":"query","description":"The field in which to perform the search","required":false,"schema":{"type":"string","default":"FULLNAME"}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VendorsResponse"}}}}}}},"/v2-edge/vendors/phone/{phoneNumber}":{"get":{"tags":["vendors-controller-v-2"],"description":"Retrieves a list of vendors identified by their unique phone number","operationId":"getVendorByPhone","parameters":[{"name":"phoneNumber","in":"path","description":"The phone number that the user set when they registered for Alero, in international format","required":true,"schema":{"pattern":"^\\+(?:[0-9] ?){6,14}[0-9]$","type":"string"},"example":"+972058655541"}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VendorResponse"}}}}}}},"/v2-edge/users/{userId}":{"get":{"tags":["users-controller-v-2"],"description":"Retrieves details of a user identified by ID","operationId":"getUserById","parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}}},"delete":{"tags":["users-controller-v-2"],"description":"Deletes a user that is identified by ID","operationId":"deleteUserById","parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/users/":{"get":{"tags":["users-controller-v-2"],"description":"Retrieves a list of users, according to a query","operationId":"getUsers","parameters":[{"name":"name","in":"query","description":"The name of the users to include in the returned list, or part of the name.\nValid values: fullname/patterns/wildcards","required":false,"schema":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","default":""}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UsersResponse"}}}}}}},"/v2-edge/sws/users/{userId}":{"get":{"tags":["sws-users-controller-v-2"],"description":"Retrieves details of a user identified by ID","operationId":"getUserById_1","parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SwsUserResponse"}}}}}},"delete":{"tags":["sws-users-controller-v-2"],"description":"Deletes a user that is identified by ID","operationId":"deleteUserById_1","parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/sws/users/":{"get":{"tags":["sws-users-controller-v-2"],"description":"Retrieves a list of SWS users, according to a query","operationId":"getUsers_1","parameters":[{"name":"name","in":"query","description":"The name of the users to include in the returned list, or part of the name.\nValid values: fullname/patterns/wildcards","required":false,"schema":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","default":""}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SwsUsersResponse"}}}}}}},"/v2-edge/sws/policies/{policyId}":{"get":{"tags":["sws-policies-controller-v-2"],"description":"Retrieves a list of SWS policies, according to a query","operationId":"getPolicyById","parameters":[{"name":"policyId","in":"path","description":"The unique ID of the policy","required":true,"schema":{"type":"string"}},{"name":"searchString","in":"query","description":"The free search string. Valid values: free text/patterns/wildcards","required":false,"schema":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","default":""}},{"name":"securityLayers","in":"query","description":"List of Policy Security Layers, as search criteria (at least single layer from the the list must be presented into searched policy)","required":true,"schema":{"type":"array","items":{"type":"string","enum":["EPM","QR","Recording","None"]}}},{"name":"memberTypes","in":"query","description":"List of Member Types, as search criteria (at least single layer from the the list must be presented into searched policy)","required":true,"schema":{"type":"array","items":{"type":"string","enum":["Group","Role","User"]}}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SwsPolicyResponse"}}}}}}},"/v2-edge/sws/policies/":{"get":{"tags":["sws-policies-controller-v-2"],"description":"Retrieves a list of SWS policies, according to a query","operationId":"getPolicies","parameters":[{"name":"searchString","in":"query","description":"The free search string.\nValid values: free text/patterns/wildcards","required":false,"schema":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","default":""}},{"name":"isRefresh","in":"query","description":"is refresh","required":false,"schema":{"type":"boolean","default":false}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SwsPoliciesResponse"}}}}}}},"/v2-edge/sws/activities":{"get":{"tags":["sws-activities-controller-v-2"],"summary":"Get SWS Tenant's Activities","description":"Get list of SWS Activities, happened between specified period","operationId":"getActivities","parameters":[{"name":"activityTypes","in":"query","description":"List of Activity Types to retrieve","required":true,"schema":{"type":"array","items":{"type":"string","enum":["RecreateTemplateRow","PolicyDeleted","PolicyConfigurationUpdated","PolicyLoaded","PolicyDefaultsPermissionsUpdated","PolicyMembersPermissionsUpdated","PolicyDisabled","PolicyEnabled","FactorUserLogin","TenantUpdated","TenantStateChanged","TenantActivated","TenantLogin","UserDeletedFromTenant","UserJointTenant","UserRoleChanged","UserActivated","UserDeactivated","CompanyUserInvitationCreated","UserUsernameChanged","SettingsUpdated"]}}},{"name":"fromTime","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"toTime","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"offset","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SwsActivitiesResponse"}}}}}}},"/v2-edge/sites":{"get":{"tags":["sites-controller-v-2"],"description":"Retrieves a list of tenant sites","operationId":"getSites","parameters":[{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SitesResponse"}}}}}}},"/v2-edge/sites/{siteId}/applications":{"get":{"tags":["applications-controller-v-2"],"operationId":"getSiteApplications","parameters":[{"name":"siteId","in":"path","description":"Site Id","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationsResponse"}}}}}}},"/v2-edge/selfServiceRequests/":{"get":{"tags":["self-service-requests-controller-v-2"],"description":"Retrieves a list of pending self-service invitation requests","operationId":"getSelfServiceRequests","parameters":[{"name":"searchString","in":"query","description":"The field in which to perform the search","required":false,"schema":{"type":"string","default":""}},{"name":"searchIn","in":"query","description":"The field in which to perform the search","required":false,"schema":{"type":"string","default":"ALL"}},{"name":"fromTime","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"toTime","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SelfServicePendingRequestsResponse"}}}}}}},"/v2-edge/invitations/vendor-invitations/{invitationId}":{"get":{"tags":["invitations-controller-v-2"],"description":"Get Vendor Invitations","operationId":"getVendorInvitation","parameters":[{"name":"invitationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VendorInvitationResponse"}}}}}},"delete":{"tags":["invitations-controller-v-2"],"description":"Delete Vendor Invitation by Id","operationId":"deleteVendorInvitationById","parameters":[{"name":"invitationId","in":"path","description":"Invitation Id","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v2-edge/invitations/vendor-invitations/":{"get":{"tags":["invitations-controller-v-2"],"description":"Get Vendor Invitations","operationId":"getVendorInvitations","parameters":[{"name":"createdBy","in":"query","description":"The ID of the Alero user who created the invitation","required":false,"schema":{"type":"string","default":""}},{"name":"searchString","in":"query","description":"The field in which to perform the search","required":false,"schema":{"type":"string","default":""}},{"name":"searchIn","in":"query","description":"The field in which to perform the search","required":false,"schema":{"type":"string","default":"FULLNAME"}},{"name":"offset","in":"query","description":"The number of entries to skip","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries to return","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VendorInvitationsLookupResponse"}}}}}}},"/v2-edge/connectors/{siteId}":{"get":{"tags":["connectors-controller-v-2"],"description":"Gets a list of tenant connectors per specified site.","operationId":"getConnectors","parameters":[{"name":"siteId","in":"path","description":"The unique ID of the site","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectorsResponse"}}}}}}},"/v2-edge/activities":{"get":{"tags":["activities-controller-v-2"],"description":"Get list of Activities, happened between specified period","operationId":"getActivities_1","parameters":[{"name":"activityTypes","in":"query","description":"List of Activity Types to retrieve","required":true,"schema":{"type":"array","items":{"type":"string","enum":["ApplicationCreated","ApplicationDeleted","ApplicationUpdated","ApplicationEnabled","ApplicationDisabled","ApplicationUserLogin","ConnectorCreated","ConnectorDeleted","ConnectorInitializationExtended","ConnectorInitialized","ConnectorUpdated","ConnectorLdapUpdated","ConnectorLdapInitialized","ConnectorLdapStopped","GroupsCreated","GroupsDeleted","GroupsUpdated","SettingsUpdated","SiteCreated","SiteDeleted","SiteUpdated","TenantAliasUpdated","TenantCreated","TenantLogin","UserActivated","UserDeactivated","VendorActivated","VendorDeactivated","VendorUpdated","UserDeleteFromTenant","VendorDeleteFromTenant","UserJoinTenant","VendorJoinTenant","UserCreated","UserUpdated","UserRoleChanged","ApplicationVendorLogin","AppCertificateCreated","AppCertificateDeleted","AppCertificateUpdated","CompanyUserInvitationCreate","VendorInvitationCreate","ServiceAccountCreated","ServiceAccountDeleted","ServiceAccountActivated","ServiceAccountDeactivated","ApplicationLoginBlocked","DirectAccessUserResponse","DirectAccessConnectionDenied","OfflineAccessUserViewedPassword","IdaptiveVendorSync","IdaptiveRoleSync","CompanyInviterUpdated"]}}},{"name":"fromTime","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"toTime","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"offset","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"maximum":500,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Custom Error","content":{"application/json":{}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActivitiesResponse"}}}}}}}},"components":{"schemas":{"InvitedToApplication":{"required":["applicationId","siteId"],"type":"object","properties":{"siteId":{"type":"string","description":"Site Id"},"applicationId":{"type":"string","description":"Application Id"}},"description":"Invitee's Application"},"VendorUpdateRequest":{"type":"object","properties":{"accessStartDate":{"minimum":0,"type":"integer","description":"The date (timestamp) when the vendor's access to Alero begins.","format":"int64"},"accessEndDate":{"minimum":0,"type":"integer","description":"The date (timestamp) when the vendor's access to Alero ends.","format":"int64"},"canInvite":{"type":"boolean","description":"Whether or not this vendor can invite other vendors."},"invitedVendorsInitialStatus":{"type":"string","description":"Whether additional vendors that will be invited by this vendor accounts are activated automatically or manually by the administrator after registration.","enum":["Activated","RequiresAdminConfirmation"]},"maxNumInvitedVendors":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The number of sub-vendors that this vendor can invite.","format":"int32"},"provisioningType":{"type":"string","description":"Invitee's Provisioning Type","enum":["ProvisionedByAlero","ManagedByAdmin","None"]},"username":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The Vault user in the CyberArk PAS environment for this vendor."},"groups":{"type":"array","description":"Groups that the vendor belongs to.","items":{"type":"string","description":"Groups that the vendor belongs to."}},"comments":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"Comments about this vendor, including the purpose of this invitation."},"applications":{"type":"array","description":"The id of the application and site to update, and the new values.","items":{"$ref":"#/components/schemas/InvitedToApplication"}},"pvwaApplications":{"type":"boolean","description":"Whether or not this vendor can access Web Applications."}},"description":"Vendor Update Request"},"SelfServiceVendorInvitationRequest":{"required":["accessEndDate","accessStartDate","applications","canInvite","initialStatus","provisioningType"],"type":"object","properties":{"initialStatus":{"type":"string","description":"Whether the vendor's account will be activated automatically or manually by the administrator after registration. ","enum":["Activated","RequiresAdminConfirmation"]},"accessStartDate":{"minimum":0,"type":"integer","description":"The date (milliseconds since Epoch) when the vendor's access to Alero begins.","format":"int64"},"accessEndDate":{"minimum":0,"type":"integer","description":"The date (milliseconds since Epoch) when the vendor's access to Alero ends..","format":"int64"},"canInvite":{"type":"boolean","description":"Whether or not this vendor can invite other vendors."},"comments":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"Comments about this vendor, including the purpose of this invitation.","nullable":true},"provisioningType":{"type":"string","description":"Invitee's Provisioning Type","enum":["ProvisionedByAlero,ManagedByAdmin,None"]},"provisioningUsername":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The Vault user in the CyberArk PAS environment that will be created for this vendor.\nThis value is mandatory for vendors with ProvisionedByAlero/ ManagedByAdmin  provisioning Type"},"provisioningGroups":{"type":"array","description":"The groups that the vendor is added to.\nThis parameter is mandatory when provisioningType is set to ProvisionedByAlero","items":{"type":"string","description":"The groups that the vendor is added to.\nThis parameter is mandatory when provisioningType is set to ProvisionedByAlero"}},"applications":{"type":"array","description":"A list of applications that the vendor can access through Alero.","items":{"$ref":"#/components/schemas/InvitedToApplication"}},"customText":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The name of a predefined invitation template added to the vendor invitation."},"maxNumOfInvitedVendors":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The number of sub-vendors that this vendor can invite.\n0 for unlimited","format":"int32"},"phoneAndEmailAuth":{"type":"boolean","description":"Whether or not this vendor will authenticate to Alero with an SMS code/phone call and a token received by email, instead of scanning the QR code with the Alero app."},"invitedVendorsInitialStatus":{"type":"string","description":"Whether additional vendors that will be invited by this vendor accounts will be activated automatically or manually by the administrator after registration","enum":["Activated","RequiresAdminConfirmation"]}},"description":"Self Service Invitation"},"VendorInvitationRequest":{"required":["accessEndDate","accessStartDate","applications","canInvite","companyName","emailAddress","firstName","initialStatus","lastName","phoneNumber","provisioningType"],"type":"object","properties":{"companyName":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The name of the company that the user represents as an Alero user."},"emailAddress":{"type":"string","description":"The user's email address in the company they represent."},"firstName":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"Vendor's first name."},"lastName":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"Vendor's last name."},"phoneNumber":{"pattern":"^\\+(?:[0-9] ?){6,14}[0-9]$","type":"string","description":"The phone number that the user set when they registered for Alero in an international format. If 'phoneAndEmailAuth' is set to 'true' this value can include an extension. The extension number structure is: <number>X<extension, example: +9721111111X123.","example":"+972058655541"},"initialStatus":{"type":"string","description":"Whether the vendor's account will be activated automatically or manually by the administrator after registration. ","enum":["Activated","RequiresAdminConfirmation"]},"accessStartDate":{"minimum":0,"type":"integer","description":"The date (timestamp) when the vendor's access to Alero begins.","format":"int64"},"accessEndDate":{"minimum":0,"type":"integer","description":"The date (timestamp) when the vendor's access to Alero ends.","format":"int64"},"canInvite":{"type":"boolean","description":"Whether or not this vendor can invite other vendors."},"comments":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"Comments about this vendor, including the purpose of this invitation.","nullable":true},"provisioningType":{"type":"string","description":"Invitee's Provisioning Type","enum":["ProvisionedByAlero,ManagedByAdmin,None"]},"provisioningUsername":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The Vault user in the CyberArk PAS environment that will be created for this vendor.\nThis value is mandatory for vendors with ProvisionedByAlero/ ManagedByAdmin  provisioning Type"},"provisioningGroups":{"type":"array","description":"The groups that the vendor is added to.\nThis parameter is mandatory when provisioningType is set to ProvisionedByAlero","items":{"type":"string","description":"The groups that the vendor is added to.\nThis parameter is mandatory when provisioningType is set to ProvisionedByAlero"}},"applications":{"type":"array","description":"A list of applications that the vendor can access through Alero.","items":{"$ref":"#/components/schemas/InvitedToApplication"}},"customText":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The name of a predefined invitation template added to the vendor invitation."},"maxNumOfInvitedVendors":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The number of sub-vendors that this vendor can invite.\n0 for unlimited","format":"int32"},"phoneAndEmailAuth":{"type":"boolean","description":"Whether or not this vendor will authenticate to Alero with an SMS code/phone call and a token received by email, instead of scanning the QR code with the Alero app."},"invitedVendorsInitialStatus":{"type":"string","description":"Whether additional vendors that will be invited by this vendor accounts will be activated automatically or manually by the administrator after registration","enum":["Activated","RequiresAdminConfirmation"]}},"description":"Vendor Invitation Request"},"UserInvitationRequest":{"required":["invitationExpirationTime"],"type":"object","properties":{"usersToInvite":{"type":"array","items":{"$ref":"#/components/schemas/UserInvitee"}},"initialStatus":{"type":"string","description":"Initial status","enum":["Deactivated"]},"invitationExpirationTime":{"minimum":0,"type":"integer","format":"int64"}}},"UserInvitee":{"required":["emailAddress","name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"pattern":"^\\p{L}([\\p{L} ,'-]|(\\. ))*\\p{L}|\\.$","type":"string","description":"Name"},"emailAddress":{"type":"string","description":"Email Address"}},"description":"User Invitee"},"GroupCreateRequest":{"required":["name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The name of the AleroLDAP group that will be added as a member to CyberArk Safes."},"description":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The description of the AleroLDAP group"}},"description":"Group Create Request"},"Group":{"required":["id","name"],"type":"object","properties":{"id":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The unique ID of the AleroLDAP group"},"name":{"maxLength":50,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The name of the AleroLDAP group"},"description":{"maxLength":100,"minLength":0,"pattern":"^[^()/><\\]\\[]*$","type":"string","description":"The description of the AleroLDAP group"},"numOfInvitations":{"type":"integer","description":"The number of pending invitations for members of this group","format":"int32"},"numOfVendors":{"type":"integer","description":"The number of vendors who are members of this group","format":"int32"}},"description":"Group details"},"VendorInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the vendor."},"username":{"type":"string","description":"The Vault user in the CyberArk PAS environment for this vendor."},"fullName":{"type":"string","description":"The full name of the vendor."},"phoneNumber":{"type":"string","description":"The phone number that the vendor set when they registered for Alero, international format.","example":"+972546222111"},"canInvite":{"type":"boolean","description":"Whether or not this vendor can invite other vendors."},"status":{"type":"string","description":"Vendor Status. For 'updateVendorStatus' operation 'PendingActivation' is not available","enum":["Deactivated","Activated","PendingActivation"]},"companyName":{"type":"string","description":"The name of the company that the user represents as an Alero user."},"emailAddress":{"type":"string","description":"The user's email address in the company they represent."},"groups":{"type":"string","description":"The groups that the vendor is a member of."}},"description":"Vendor Info"},"VendorsResponse":{"type":"object","properties":{"vendors":{"type":"array","description":"Vendors List","items":{"$ref":"#/components/schemas/VendorInfo"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"Vendors Response"},"VendorResponse":{"type":"object","properties":{"id":{"type":"string","description":"Vendor's id"},"username":{"type":"string","description":"The Vault user in the CyberArk PAS environment for this vendor."},"firstName":{"type":"string","description":"Vendor's first name."},"lastName":{"type":"string","description":"Vendor's last name."},"emailAddress":{"type":"string","description":"The user's email address in the company they represent."},"phoneNumber":{"type":"string","description":"The phone number that the user set when they registered for Alero, international format","example":"+972546222111"},"phoneModel":{"type":"string","description":"Vendor's phone model."},"phoneOs":{"type":"string","description":"Vendor's phone operating system type."},"canInvite":{"type":"boolean","description":"Whether or not this vendor can invite other vendors."},"status":{"type":"string","description":"Vendor Status. For 'updateVendorStatus' operation 'PendingActivation' is not available","enum":["Deactivated","Activated","PendingActivation"]},"appVersion":{"type":"string","description":"Vendor's Alero mobile app version"},"phoneAndEmailAuth":{"type":"boolean","description":"Whether or not this vendor authenticates to Alero with an SMS code/phone call and a token received by email, instead of scanning the QR code with the Alero app."},"companyName":{"type":"string","description":"The name of the company that the user represents as an Alero user."},"lastLogin":{"type":"integer","description":"The date (timestamp) of the vendor's last login.","format":"int64"},"applications":{"type":"array","description":"A list of applications that the vendor can access through Alero.","items":{"$ref":"#/components/schemas/InvitedToApplication"}},"comments":{"type":"string","description":"Comments about this vendor."},"accessStartDate":{"type":"integer","description":"The date (timestamp) when the vendor's access to Alero begins.","format":"int64"},"accessEndDate":{"type":"integer","description":"The date (timestamp) when the vendor's access to Alero ends.","format":"int64"},"groups":{"type":"array","description":"The groups that the vendor is a member of.","items":{"$ref":"#/components/schemas/Group"}},"maxNumOfInvitedVendors":{"type":"integer","description":"The number of sub-vendors that this vendor can invite. 0 for unlimited","format":"int32"},"invitedVendorsInitialStatus":{"type":"string","description":"Whether additional vendors that will be invited by this vendor accounts will be activated automatically or manually by the administrator after registration","enum":["Activated","Deactivated","RequiresAdminConfirmation"]},"provisioningType":{"type":"string","description":"Invitee's Provisioning Type","enum":["ProvisionedByAlero","ManagedByAdmin","None"]},"emailConfirmedAt":{"type":"integer","description":"The date (timestamp) when the email address was confirmed","format":"int64"},"invitationId":{"type":"string","description":"The id of the vendor's invitation that the vendor used to join Alero"},"invitedBy":{"type":"string","description":"The full name of the vendor who invited this vendor."}},"description":"Vendor Response"},"UserResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the user."},"invitedBy":{"type":"string","description":"The unique identifier of the user who invited this user."},"username":{"type":"string","description":"User's first name."},"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"User's first name. "},"phoneNumber":{"type":"string","description":"The phone number that the user set when they registered for Alero.","example":"+972546222111"},"phoneModel":{"type":"string","description":"User's phone model."},"phoneOS":{"type":"string","description":"User's phone operating system type."},"role":{"type":"string","description":"User Role","enum":["TenantAdmin","User","VendorManager"]},"status":{"type":"string","description":"User Status","enum":["Deactivated","Activated","PendingActivation"]},"lastLogin":{"type":"integer","description":"Last Login Time, (Milliseconds since Epoch)","format":"int64"},"appVersion":{"type":"string","description":"Alero user's mobile app version"}},"description":"User Info"},"UserInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the user."},"username":{"type":"string","description":"The Vault user in the CyberArk PAS environment for this vendor."},"fullname":{"type":"string","description":"The full name of the user"},"phoneNumber":{"type":"string","description":"The phone number that the vendor set when they registered for Alero, international format","example":"+972546222111"},"phoneModel":{"type":"string","description":"User's phone model."},"invitedBy":{"type":"string","description":"The unique identifier of the user who invited this user."},"lastLogin":{"type":"integer","description":"Last Login Time, (Milliseconds since Epoch)","format":"int64"},"role":{"type":"string","description":"User Role","enum":["TenantAdmin","User","VendorManager"]},"status":{"type":"string","description":"User Status","enum":["Deactivated","Activated","PendingActivation"]},"appVersion":{"type":"string","description":"Alero user's mobile app version"}},"description":"User Info"},"UsersResponse":{"type":"object","properties":{"users":{"type":"array","description":"Users List","items":{"$ref":"#/components/schemas/UserInfo"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"Users Response"},"SwsUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the user."},"invitedBy":{"type":"string","description":"The unique identifier of the user who invited this user."},"username":{"type":"string","description":"This is the username from the tenant's integrated Active Directory."},"firstName":{"type":"string","description":"User's first Name"},"lastName":{"type":"string","description":"User's last name. "},"phoneNumber":{"type":"string","description":"The phone number that the user set when they registered.","example":"+972546222111"},"phoneModel":{"type":"string","description":"User's phone model."},"phoneOS":{"type":"string","description":"User's phone operating system type."},"role":{"type":"string","description":"User Role","enum":["TenantAdmin","User","VendorManager"]},"status":{"type":"string","description":"User Status","enum":["Deactivated","Activated","PendingActivation"]},"lastLogin":{"type":"integer","description":"Last Login Time, (Milliseconds since Epoch)","format":"int64"},"appVersion":{"type":"string","description":"User's mobile app version"}},"description":"User Info"},"SwsUserInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the user."},"username":{"type":"string","description":"This is the username from the tenant's integrated Active Directory."},"fullname":{"type":"string","description":"The full name of the user"},"phoneNumber":{"type":"string","description":"The phone number that the vendor set when they registered, international format","example":"+972546222111"},"phoneModel":{"type":"string","description":"User's phone model."},"invitedBy":{"type":"string","description":"The unique identifier of the user who invited this user."},"lastLogin":{"type":"integer","description":"Last Login Time, (Milliseconds since Epoch)","format":"int64"},"role":{"type":"string","description":"User Role","enum":["TenantAdmin","User","VendorManager"]},"status":{"type":"string","description":"User Status","enum":["Deactivated","Activated","PendingActivation"]},"appVersion":{"type":"string","description":"User's mobile app version"}},"description":"SWS User Info"},"SwsUsersResponse":{"type":"object","properties":{"users":{"type":"array","description":"Users List","items":{"$ref":"#/components/schemas/SwsUserInfo"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"SWS Users Response"},"PolicyApplication":{"type":"object","properties":{"name":{"type":"string","description":"The name of the application"},"keyId":{"type":"string","description":"The key ID of the application"},"logo":{"type":"string","description":"The logo of the application"}},"description":"SWS Policy Application"},"PolicyConfiguration":{"type":"object","properties":{"dynamicURLsExclusions":{"type":"array","description":"Steps Recording configuration: URLs list, excluded from recording","items":{"type":"string","description":"Steps Recording configuration: URLs list, excluded from recording"}},"dynamicURLsMode":{"type":"string","description":"Steps Recording configuration: Dynamic URLs Mode","enum":["Auto","Manual"]},"blockActions":{"type":"boolean"},"enforceEPM":{"type":"boolean"}},"description":"SWS Policy Configuration"},"PolicyEPMStatus":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Whether EPM is active"}},"description":"SWS Policy EPM Status"},"PolicyMember":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the policy member"},"name":{"type":"string","description":"The name  of the policy member"},"securityLayers":{"type":"array","description":"list of member's security layers","items":{"type":"string","description":"list of member's security layers","enum":["EPM","QR","Recording","None"]}},"type":{"type":"string","description":"The type of the member","enum":["Group","Role","User"]}},"description":"SWS Policy Member"},"PolicyMemberStats":{"type":"object","properties":{"zeroLayersCount":{"type":"integer","description":"Number of members with no Security Layers","format":"int32"},"oneLayersCount":{"type":"integer","description":"Number of members with one Security Layer","format":"int32"},"twoLayersCount":{"type":"integer","description":"Number of members with two Security Layers","format":"int32"},"threeLayersCount":{"type":"integer","description":"Number of members with three Security Layers","format":"int32"},"total":{"type":"integer","description":"Total number of members","format":"int32"}},"description":"SWS Policy Member Statistics Data"},"SwsPolicyInfo":{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"appKey":{"type":"string"},"active":{"type":"boolean"}},"description":"SWS Policy Details"},"SwsPolicyMembers":{"type":"object","properties":{"members":{"type":"array","description":"SWS Policy members List","items":{"$ref":"#/components/schemas/PolicyMember"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"},"lastUpdate":{"type":"integer","description":"The Last Update Time (Milliseconds since Epoch)","format":"int64"}},"description":"SWS policy members data"},"SwsPolicyResponse":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/SwsPolicyInfo"},"configuration":{"$ref":"#/components/schemas/PolicyConfiguration"},"epmStatus":{"$ref":"#/components/schemas/PolicyEPMStatus"},"members":{"$ref":"#/components/schemas/SwsPolicyMembers"}},"description":"SWS Policy Response"},"SwsPoliciesResponse":{"type":"object","properties":{"policies":{"type":"array","description":"SWS Policies List","items":{"$ref":"#/components/schemas/SwsPolicyInfo"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"},"lastUpdate":{"type":"integer","description":"The Last Update Time (Milliseconds since Epoch)","format":"int64"}},"description":"SWS Policies Response"},"SettingsUpdate":{"type":"object","properties":{"key":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"}},"description":"SWS Policy Details"},"SwsActivitiesResponse":{"type":"object","properties":{"activities":{"type":"array","description":"Total number of activities with selected types","items":{"$ref":"#/components/schemas/SwsActivity"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"SWS Activity details, contains list of Activities"},"SwsActivity":{"required":["activityData"],"type":"object","properties":{"activityType":{"type":"string","description":"Activity Type","enum":["RecreateTemplateRow","PolicyDeleted","PolicyConfigurationUpdated","PolicyLoaded","PolicyDefaultsPermissionsUpdated","PolicyMembersPermissionsUpdated","PolicyDisabled","PolicyEnabled","FactorUserLogin","TenantUpdated","TenantStateChanged","TenantActivated","TenantLogin","UserDeletedFromTenant","UserJointTenant","UserRoleChanged","UserActivated","UserDeactivated","CompanyUserInvitationCreated","UserUsernameChanged","SettingsUpdated"]},"activityData":{"oneOf":[{"$ref":"#/components/schemas/SwsCompanyUserInvitationCreatedActivity"},{"$ref":"#/components/schemas/SwsFactorUserLoginActivity"},{"$ref":"#/components/schemas/SwsPoliciesDeletedActivity"},{"$ref":"#/components/schemas/SwsPolicyConfigurationUpdatedActivity"},{"$ref":"#/components/schemas/SwsPolicyDefaultPermissionsUpdatedActivity"},{"$ref":"#/components/schemas/SwsPolicyDisabledActivity"},{"$ref":"#/components/schemas/SwsPolicyEnabledActivity"},{"$ref":"#/components/schemas/SwsPolicyLoadedActivity"},{"$ref":"#/components/schemas/SwsPolicyMembersPermissionsUpdatedActivity"},{"$ref":"#/components/schemas/SwsRecreateTemplateRowActivity"},{"$ref":"#/components/schemas/SwsSettingsUpdatedActivity"},{"$ref":"#/components/schemas/SwsTenantActivatedActivity"},{"$ref":"#/components/schemas/SwsTenantLoginActivity"},{"$ref":"#/components/schemas/SwsTenantStateChangedActivity"},{"$ref":"#/components/schemas/SwsTenantUpdatedActivity"},{"$ref":"#/components/schemas/SwsUserActivatedActivity"},{"$ref":"#/components/schemas/SwsUserDeactivatedActivity"},{"$ref":"#/components/schemas/SwsUserDeletedFromTenantActivity"},{"$ref":"#/components/schemas/SwsUserJointTenantActivity"},{"$ref":"#/components/schemas/SwsUserRoleChangedActivity"},{"$ref":"#/components/schemas/SwsUserUsernameChangedActivity"}]}},"description":"Activity details, related to activity, occur in tenant"},"SwsBaseActivity":{"type":"object","properties":{"id":{"type":"string"},"time":{"type":"integer","format":"int64"},"initiatedById":{"type":"string"},"initiatedByName":{"type":"string"},"initiatedByRole":{"type":"string"}},"description":"Base Activity, presented common fields, contained in every subclass model. The field's model may be any subclass of 'SwsBaseActivity', depended on 'activityType' value. Model name is a concatenation of two 'activityType' value  + 'Activity' suffix, example: 'SiteCreatedActivity'"},"SwsCompanyUserInvitationCreatedActivity":{"type":"object","description":"SWS Company User Invitation Created Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"invitationId":{"type":"string"},"initialStatus":{"type":"string"},"email":{"type":"string"}}}]},"SwsFactorUserLoginActivity":{"type":"object","description":"SWS Factor User Login Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"fullname":{"type":"string"},"userLoginName":{"type":"string"},"loginTime":{"type":"integer","format":"int64"},"policyId":{"type":"string"},"policyName":{"type":"string"},"config":{"$ref":"#/components/schemas/SwsPolicyConfig"},"permissions":{"$ref":"#/components/schemas/SwsPolicyUserPermissions"},"sourceIp":{"type":"string"}}}]},"SwsPoliciesDeletedActivity":{"type":"object","description":"SWS Policy Deleted Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"deletedPolicies":{"type":"array","items":{"$ref":"#/components/schemas/SwsPolicyInfo"}}}}]},"SwsPolicyConfig":{"type":"object","properties":{"dynamicUrls":{"type":"boolean"},"urls":{"type":"array","items":{"type":"string"}},"recordingLevel":{"type":"string"},"epmEnabled":{"type":"boolean"},"clipboardRestrictionEnabled":{"type":"boolean"},"downloadRestrictionEnabled":{"type":"boolean"}},"description":"SWS Policy Configuration Details"},"SwsPolicyConfigurationUpdatedActivity":{"type":"object","description":"SWS Policy Configuration Updated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"oldConfig":{"$ref":"#/components/schemas/SwsPolicyConfig"},"updatedConfig":{"$ref":"#/components/schemas/SwsPolicyConfig"}}}]},"SwsPolicyDefaultPermissionUpdate":{"type":"object","properties":{"oldPermissions":{"$ref":"#/components/schemas/SwsPolicyUserPermissions"},"updatedPermissions":{"$ref":"#/components/schemas/SwsPolicyUserPermissions"}},"description":"SWS Policy Default Permissions Update Details"},"SwsPolicyDefaultPermissionsUpdatedActivity":{"type":"object","description":"SWS Policy Default Permission Updated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"appKey":{"type":"string"},"active":{"type":"boolean"},"defaultPermissionUpdate":{"$ref":"#/components/schemas/SwsPolicyDefaultPermissionUpdate"}}}]},"SwsPolicyDisabledActivity":{"type":"object","description":"SWS Policy Disabled Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"appKey":{"type":"string"},"active":{"type":"boolean"},"numPermissions":{"type":"integer","format":"int32"}}}]},"SwsPolicyEnabledActivity":{"type":"object","description":"SWS Policy Enabled Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"appKey":{"type":"string"},"active":{"type":"boolean"},"numPermissions":{"type":"integer","format":"int32"}}}]},"SwsPolicyLoadedActivity":{"type":"object","description":"SWS Policy Loaded Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"appKey":{"type":"string"},"active":{"type":"boolean"},"numPermissions":{"type":"integer","format":"int32"}}}]},"SwsPolicyMembersPermissionsUpdatedActivity":{"type":"object","description":"SWS Policy Members Permission Updated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"appKey":{"type":"string"},"active":{"type":"boolean"},"updatedPermissions":{"type":"array","items":{"$ref":"#/components/schemas/SwsPolicyUserPermissionUpdate"}}}}]},"SwsPolicyUserPermissionUpdate":{"type":"object","properties":{"oldPermissions":{"$ref":"#/components/schemas/SwsPolicyUserPermissions"},"updatedPermissions":{"$ref":"#/components/schemas/SwsPolicyUserPermissions"},"name":{"type":"string"},"type":{"type":"string"}},"description":"SWS Policy User Permission Update details"},"SwsPolicyUserPermissions":{"type":"object","properties":{"sessionProtection":{"type":"boolean"},"continuousAuthentication":{"type":"boolean"},"recording":{"type":"boolean"}},"description":"SWS Policy User Permissions"},"SwsRecreateTemplateRowActivity":{"type":"object","description":"SWS Recreate Template Row Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"}]},"SwsSettingsUpdatedActivity":{"type":"object","description":"SWS Settings Updated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"updatedSettings":{"type":"array","items":{"$ref":"#/components/schemas/SettingsUpdate"}}}}]},"SwsTenantActivatedActivity":{"type":"object","description":"SWS Activated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"tenantType":{"type":"integer","format":"int32"}}}]},"SwsTenantLoginActivity":{"type":"object","description":"SWS Tenant Login Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userLoginName":{"type":"string"},"loginType":{"type":"string"},"loginTime":{"type":"integer","format":"int64"},"sourceIp":{"type":"string"}}}]},"SwsTenantState":{"type":"object","properties":{"id":{"type":"string"},"companyName":{"type":"string"},"salesforceId":{"type":"string"},"logo":{"type":"string"},"logoThumbnail":{"type":"string"}},"description":"SWS Tenant State"},"SwsTenantStateChangedActivity":{"type":"object","description":"SWS State Changed Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"tenantType":{"type":"integer","format":"int32"},"oldState":{"type":"integer","format":"int32"},"newState":{"type":"integer","format":"int32"},"reason":{"type":"string"}}}]},"SwsTenantUpdatedActivity":{"type":"object","description":"SWS Tenant Updated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"currentTenantState":{"$ref":"#/components/schemas/SwsTenantState"},"updatedTenantState":{"$ref":"#/components/schemas/SwsTenantState"},"updatedByUserId":{"type":"string"}}}]},"SwsUserActivatedActivity":{"type":"object","description":"SWS User Activated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userRole":{"type":"string"},"userType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]}}}]},"SwsUserDeactivatedActivity":{"type":"object","description":"SWS User Deactivated Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userRole":{"type":"string"},"userType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]}}}]},"SwsUserDeletedFromTenantActivity":{"type":"object","description":"SWS User Deleted Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userRole":{"type":"string"},"userType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]},"reason":{"type":"string","enum":["UserInitiated","GlobalUserDeleted","UserRemovedFromIdp"]}}}]},"SwsUserJointTenantActivity":{"type":"object","description":"SWS User Joint Tenant Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userPhoneNumber":{"type":"string"},"inviterUserId":{"type":"string"},"inviterUserName":{"type":"string"},"inviterUserRole":{"type":"string"},"inviterUserType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]},"active":{"type":"boolean"}}}]},"SwsUserRoleChangedActivity":{"type":"object","description":"SWS User Role Changed Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userId":{"type":"string"},"userName":{"type":"string"},"updatedUserRole":{"type":"string"},"userType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]},"userLoginName":{"type":"string"}}}]},"SwsUserUsernameChangedActivity":{"type":"object","description":"SWS User Username Changed Activity details","allOf":[{"$ref":"#/components/schemas/SwsBaseActivity"},{"type":"object","properties":{"userId":{"type":"string"},"userName":{"type":"string"},"userRole":{"type":"string"},"userType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]},"userLoginName":{"type":"string"},"userOldLoginName":{"type":"string"}}}]},"Site":{"type":"object","properties":{"id":{"type":"string","description":"The site's unique id."},"displayName":{"type":"string","description":"The site's display name in Alero."},"description":{"type":"string","description":"The site's description."},"type":{"type":"string","description":"The site's type."},"createdByUserId":{"type":"string","description":"The id of the user that created the site."},"creationTime":{"type":"integer","description":"The date (timestamp) when the site was created.","format":"int64"},"updatedByUserId":{"type":"string","description":"The id of the user that updated the site"},"updateTime":{"type":"integer","description":"The date (timestamp) when the site was last updated.","format":"int64"}},"description":"Site details"},"SitesResponse":{"type":"object","properties":{"sites":{"type":"array","description":"Sites List","items":{"$ref":"#/components/schemas/Site"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"List of tenant sites"},"Application":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"name":{"type":"string","description":"Name"},"authenticationMethod":{"type":"string","description":"Authentication Method, used for applications's access","enum":["SAML","OpenID","None"]},"createdByUserId":{"type":"string","description":"Creator's Id"},"creationTime":{"type":"integer","description":"Creation Time (Milliseconds since Epoch)","format":"int64"},"lastUpdatedByUserId":{"type":"string","description":"User Id, Performed Last Update"},"lastUpdateTime":{"type":"integer","description":"Last Update Time (Milliseconds since Epoch)","format":"int64"},"logo":{"type":"string","description":"Logo"},"internalUri":{"type":"string","description":"Internal URI"},"certificateId":{"type":"string","description":"Certificate URI"},"externalUri":{"type":"string","description":"External URI"},"nestedApplications":{"type":"array","description":"List of Nested Applications","items":{"$ref":"#/components/schemas/NestedApplication"}},"enabled":{"type":"boolean"}},"description":"Application details"},"ApplicationsResponse":{"type":"object","properties":{"applications":{"type":"array","description":"list of Applications","items":{"$ref":"#/components/schemas/Application"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"Application Response Object"},"NestedApplication":{"type":"object","properties":{"externalUri":{"type":"string","description":"External URI"},"internalUri":{"type":"string","description":"Internal URI"},"certificateId":{"type":"string","description":"Certificate Id"}},"description":"Nested Application"},"SelfServicePendingRequestData":{"required":["emailAddress"],"type":"object","properties":{"createdAt":{"type":"integer","description":"The date (Milliseconds since Epoch)) when the request was created.","format":"int64"},"id":{"type":"string","description":"Unique identifier of the request."},"emailAddress":{"type":"string","description":"Vendor's email address in the company they represent."},"fullName":{"type":"string","description":"Full name of the vendor who submitted the request."},"phoneNumber":{"type":"string","description":"Phone number that the user set when they registered for Alero."},"companyName":{"type":"string","description":"Name of the company that the vendor specified as part of the request."},"requestComments":{"type":"string","description":"Comments submitted by the vendor as part of the request."},"requestedAccessStartDate":{"type":"integer","description":"The date (milliseconds since Epoch)) when the vendor requested to begin access to Alero .","format":"int64"},"requestedAccessEndDate":{"type":"integer","description":"The date (milliseconds since Epoch)) when the vendor requested to end access to Alero.","format":"int64"}},"description":"Vendor Pending Self Service Invitation Request Data"},"SelfServicePendingRequestsResponse":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"},"requests":{"type":"array","items":{"$ref":"#/components/schemas/SelfServicePendingRequestData"}}}},"VendorInvitationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The vendor's invitation id."},"initializerId":{"type":"string","description":"The id of the service account that created the vendor's invitation."},"companyName":{"type":"string","description":"The name of the company that the user represents as an Alero user."},"emailAddress":{"type":"string","description":"The vendor's email address in the company they represent."},"firstName":{"type":"string","description":"Vendor's first name"},"lastName":{"type":"string","description":"Vendor's last name"},"phoneNumber":{"type":"string","description":"The phone number that the user set when they registered for Alero.","example":"+972546222111"},"initialStatus":{"type":"string","description":"Whether the vendor's account are activated automatically or manually by the administrator after registration. ","enum":["Activated","RequiresAdminConfirmation"]},"invitedVendorsInitialStatus":{"type":"string","description":"Whether additional vendors that will be invited by this vendor accounts are activated automatically or manually by the administrator after registration.","enum":["Activated","RequiresAdminConfirmation"]},"accessStartDate":{"type":"integer","description":"The date (timestamp) when the vendor's access to Alero ends.","format":"int64"},"accessEndDate":{"type":"integer","description":"The date (timestamp) when the vendor's access to Alero begins.","format":"int64"},"createdAt":{"type":"integer","description":"The date (timestamp) when the invitation was created.","format":"int64"},"expiredAt":{"type":"integer","description":"The date (timestamp) when the vendor's invitation expires","format":"int64"},"canInvite":{"type":"boolean","description":"Whether or not this vendor can invite other vendors."},"comments":{"type":"string","description":"Comments about this vendor, including the purpose of this invitation."},"provisioningType":{"type":"string","description":"Invitee's Provisioning Type","enum":["ProvisionedByAlero","ManagedByAdmin","None"]},"provisioningUserName":{"type":"string","description":"The Vault user in the CyberArk PAS environment that was created for this vendor. This value is only relevant for vendors with \"ProvisionedByAlero\" provisioning Type"},"provisioningGroups":{"type":"array","description":"The groups that the vendor is added to","items":{"$ref":"#/components/schemas/Group"}},"applications":{"type":"array","description":"A list of applications that the vendor can access through Alero","items":{"$ref":"#/components/schemas/InvitedToApplication"}},"customText":{"type":"string","description":"The name of a predefined invitation template added to the vendor invitation."},"maxNumOfInvitedVendors":{"type":"integer","description":"The number of sub-vendors that this vendor can invite.\nSpecify 0 for unlimited","format":"int32"},"phoneAndEmailAuth":{"type":"boolean","description":"Whether or not this vendor will authenticate to Alero with an SMS code/phone call and a token received by email, instead of scanning the QR code with the Alero app."}},"description":"Vendor Invitation Response"},"VendorInvitationLookupData":{"type":"object","properties":{"companyName":{"type":"string","description":"The name of the company that the user represents as an Alero user."},"emailAddress":{"type":"string","description":"The user's email address in the company they represent."},"expiredAt":{"type":"integer","description":"The date (timestamp) when the vendor's invitation expires.","format":"int64"},"fullName":{"type":"string","description":"Vendor's full name."},"groups":{"type":"string","description":"A list of the groups that the vendor belong to."},"invitationId":{"type":"string","description":"The vendor's invitation id."},"phoneNumber":{"type":"string","description":"The phone number that the user set when they registered for Alero.\nIf 'phoneAndEmailAuth' is set to 'true' this value can include an extension","example":"+972546222111"},"phoneAndEmailAuth":{"type":"boolean","description":"Whether or not this vendor authenticates to Alero with an SMS code/phone call and a token received by email, instead of scanning the QR code with the Alero app"}},"description":"Vendor Invitation Lookup Data"},"VendorInvitationsLookupResponse":{"type":"object","properties":{"invitations":{"type":"array","description":"Invitations List","items":{"$ref":"#/components/schemas/VendorInvitationLookupData"}},"totalCount":{"type":"integer","description":"TThe number of entries that match the query","format":"int64"}},"description":"Vendor Invitation Lookup Response"},"GroupsResponse":{"type":"object","properties":{"groups":{"type":"array","description":"Groups List","items":{"$ref":"#/components/schemas/Group"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"Group Create Response"},"Connector":{"type":"object","properties":{"id":{"type":"string","description":"The connector's unique id."},"name":{"type":"string","description":"The connector's display name."},"description":{"type":"string","description":"The connector's description."},"createdAt":{"type":"integer","description":"The date (timestamp) when the connector was created.","format":"int64"},"version":{"type":"string","description":"The connector's version."},"siteId":{"type":"string","description":"The Id of the site where the connector is located."},"connectorStatus":{"type":"string","description":"The status of the connector.","enum":["Pending","Initializing","Operational","Unexpected"]},"connected":{"type":"boolean","description":"Whether or not this connector is connected to Remote Access Server."},"vendorLdapRunning":{"type":"boolean","description":"Whether or not Vendor LDAP is running."},"secureTunnelRunning":{"type":"boolean","description":"Whether or not secure tunnel is running."},"reverseProxyRunning":{"type":"boolean","description":"Whether or not reverse proxy is running"},"numOfApplications":{"type":"integer","description":"The number of applications accessed by the connector.","format":"int32"},"numOfUsers":{"type":"integer","description":"The number of users serviced by the connector","format":"int32"},"lastUpdateAt":{"type":"integer","description":"The date (timestamp) of the connector's last update.","format":"int64"},"connectorCertificateExpiresAt":{"type":"integer","description":"The date (timestamp) when the connector certificate expires","format":"int64"},"vendorLdapInitialized":{"type":"boolean","description":"Whether or not Vendor LDAP is initialized."},"vendorLdapCertificateExpiresAt":{"type":"integer","description":"The date (timestamp) when the Vendor LDAP certificate expires","format":"int64"}},"description":"Connector details"},"ConnectorsResponse":{"type":"object","properties":{"connectors":{"type":"array","description":"Connectors List","items":{"$ref":"#/components/schemas/Connector"}},"totalCount":{"type":"integer","description":"The total number of connectors in the returned list.","format":"int64"}},"description":"List of tenant connectors"},"ActivitiesResponse":{"type":"object","properties":{"activities":{"type":"array","description":"Total number of activities with selected types","items":{"$ref":"#/components/schemas/Activity"}},"totalCount":{"type":"integer","description":"The number of entries that match the query","format":"int64"}},"description":"Activity details, contains list of Activities"},"Activity":{"required":["activityData"],"type":"object","properties":{"activityType":{"type":"string","description":"Activity Type","enum":["ApplicationCreated","ApplicationDeleted","ApplicationUpdated","ApplicationEnabled","ApplicationDisabled","ApplicationUserLogin","ConnectorCreated","ConnectorDeleted","ConnectorInitializationExtended","ConnectorInitialized","ConnectorUpdated","ConnectorLdapUpdated","ConnectorLdapInitialized","ConnectorLdapStopped","GroupsCreated","GroupsDeleted","GroupsUpdated","SettingsUpdated","SiteCreated","SiteDeleted","SiteUpdated","TenantAliasUpdated","TenantCreated","TenantLogin","UserActivated","UserDeactivated","VendorActivated","VendorDeactivated","VendorUpdated","UserDeleteFromTenant","VendorDeleteFromTenant","UserJoinTenant","VendorJoinTenant","UserCreated","UserUpdated","UserRoleChanged","ApplicationVendorLogin","AppCertificateCreated","AppCertificateDeleted","AppCertificateUpdated","CompanyUserInvitationCreate","VendorInvitationCreate","ServiceAccountCreated","ServiceAccountDeleted","ServiceAccountActivated","ServiceAccountDeactivated","ApplicationLoginBlocked","DirectAccessUserResponse","DirectAccessConnectionDenied","OfflineAccessUserViewedPassword","IdaptiveVendorSync","IdaptiveRoleSync","CompanyInviterUpdated"]},"activityData":{"oneOf":[{"$ref":"#/components/schemas/AppCertificateCreatedActivity"},{"$ref":"#/components/schemas/AppCertificateDeletedActivity"},{"$ref":"#/components/schemas/AppCertificateUpdatedActivity"},{"$ref":"#/components/schemas/ApplicationCreatedActivity"},{"$ref":"#/components/schemas/ApplicationDeletedActivity"},{"$ref":"#/components/schemas/ApplicationDisabledActivity"},{"$ref":"#/components/schemas/ApplicationEnabledActivity"},{"$ref":"#/components/schemas/ApplicationLoginBlockedActivity"},{"$ref":"#/components/schemas/ApplicationUpdatedActivity"},{"$ref":"#/components/schemas/ApplicationUserLoginActivity"},{"$ref":"#/components/schemas/ApplicationVendorLoginActivity"},{"$ref":"#/components/schemas/CompanyInviterUpdatedActivity"},{"$ref":"#/components/schemas/ConnectorCreatedActivity"},{"$ref":"#/components/schemas/ConnectorDeletedActivity"},{"$ref":"#/components/schemas/ConnectorInitializationExtendedActivity"},{"$ref":"#/components/schemas/ConnectorInitializedActivity"},{"$ref":"#/components/schemas/ConnectorLdapInitializedActivity"},{"$ref":"#/components/schemas/ConnectorLdapStoppedActivity"},{"$ref":"#/components/schemas/ConnectorLdapUpdatedActivity"},{"$ref":"#/components/schemas/ConnectorUpdatedActivity"},{"$ref":"#/components/schemas/DirectAccessConnectionDeniedActivity"},{"$ref":"#/components/schemas/DirectAccessUserResponseActivity"},{"$ref":"#/components/schemas/GroupsCreatedActivity"},{"$ref":"#/components/schemas/GroupsDeletedActivity"},{"$ref":"#/components/schemas/GroupsUpdatedActivity"},{"$ref":"#/components/schemas/IdaptiveRoleSyncActivity"},{"$ref":"#/components/schemas/IdaptiveVendorSyncActivity"},{"$ref":"#/components/schemas/LicenseUpdatedActivity"},{"$ref":"#/components/schemas/OfflineAccessUserViewedPasswordActivity"},{"$ref":"#/components/schemas/ServiceAccountActivatedActivity"},{"$ref":"#/components/schemas/ServiceAccountCreatedActivity"},{"$ref":"#/components/schemas/ServiceAccountDeactivatedActivity"},{"$ref":"#/components/schemas/ServiceAccountDeletedActivity"},{"$ref":"#/components/schemas/ServiceAccountRoleChangedActivity"},{"$ref":"#/components/schemas/ServiceAccountUpdatedActivity"},{"$ref":"#/components/schemas/ServiceAccountsAccessChangedActivity"},{"$ref":"#/components/schemas/SettingsUpdatedActivity"},{"$ref":"#/components/schemas/SiteCreatedActivity"},{"$ref":"#/components/schemas/SiteDeletedActivity"},{"$ref":"#/components/schemas/SiteUpdatedActivity"},{"$ref":"#/components/schemas/TenantAliasUpdatedActivity"},{"$ref":"#/components/schemas/TenantCreatedActivity"},{"$ref":"#/components/schemas/TenantLoginActivity"},{"$ref":"#/components/schemas/UserActivatedActivity"},{"$ref":"#/components/schemas/UserChangedUsernameInTenantActivity"},{"$ref":"#/components/schemas/UserCreatedActivity"},{"$ref":"#/components/schemas/UserDeactivatedActivity"},{"$ref":"#/components/schemas/UserDeletedFromTenantActivity"},{"$ref":"#/components/schemas/UserInvitationCreatedActivity"},{"$ref":"#/components/schemas/UserJoinedToTenantActivity"},{"$ref":"#/components/schemas/UserRoleChangedActivity"},{"$ref":"#/components/schemas/UserUpdatedActivity"},{"$ref":"#/components/schemas/VendorActivatedActivity"},{"$ref":"#/components/schemas/VendorDeactivatedActivity"},{"$ref":"#/components/schemas/VendorDeletedFromTenantActivity"},{"$ref":"#/components/schemas/VendorInvitationCreatedActivity"},{"$ref":"#/components/schemas/VendorInvitationDeletedActivity"},{"$ref":"#/components/schemas/VendorJoinedToTenantActivity"},{"$ref":"#/components/schemas/VendorUpdatedActivity"}]}},"description":"Activity details, related to activity, occur in tenant"},"AppCertificateCreatedActivity":{"type":"object","description":"Application Certificate Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"certId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"subjectName":{"type":"string"},"validFrom":{"type":"integer","format":"int64"},"validTo":{"type":"integer","format":"int64"}}}]},"AppCertificateDeletedActivity":{"type":"object","description":"Application Certificate Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"certId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"subjectName":{"type":"string"},"validFrom":{"type":"integer","format":"int64"},"validTo":{"type":"integer","format":"int64"}}}]},"AppCertificateUpdatedActivity":{"type":"object","description":"Application Certificate Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"}}}]},"ApplicationCreatedActivity":{"type":"object","description":"Application Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"status":{"type":"string","enum":["Published","Hidden"]},"internalUrl":{"type":"string"},"externalUrl":{"type":"string"},"externalFQDNType":{"type":"integer","format":"int32"},"nestedApps":{"type":"array","items":{"$ref":"#/components/schemas/NestedApplication"}}}}]},"ApplicationDeletedActivity":{"type":"object","description":"Application Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"status":{"type":"string","enum":["Published","Hidden"]},"internalUrl":{"type":"string"},"externalUrl":{"type":"string"},"externalFQDNType":{"type":"integer","format":"int32"},"nestedApps":{"type":"array","items":{"$ref":"#/components/schemas/NestedApplication"}}}}]},"ApplicationDisabledActivity":{"type":"object","description":"Application Disabled Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"status":{"type":"string","enum":["Published","Hidden"]},"internalUrl":{"type":"string"},"externalUrl":{"type":"string"},"externalFQDNType":{"type":"integer","format":"int32"},"nestedApps":{"type":"array","items":{"$ref":"#/components/schemas/NestedApplication"}}}}]},"ApplicationEnabledActivity":{"type":"object","description":"Application Enabled Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"status":{"type":"string","enum":["Published","Hidden"]},"internalUrl":{"type":"string"},"externalUrl":{"type":"string"},"externalFQDNType":{"type":"integer","format":"int32"},"nestedApps":{"type":"array","items":{"$ref":"#/components/schemas/NestedApplication"}}}}]},"ApplicationLoginBlockedActivity":{"type":"object","description":"Application  Login  Blocked Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"applicationName":{"type":"string"},"applicationLoginUsername":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"externalUri":{"type":"string"},"internalUri":{"type":"string"},"loginTime":{"type":"integer","format":"int64"},"sourceIp":{"type":"string"},"reason":{"type":"string"}}}]},"ApplicationUpdatedActivity":{"type":"object","description":"Application Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"creationTime":{"type":"integer","format":"int64"},"updateTime":{"type":"integer","format":"int64"},"createdByUserId":{"type":"string"},"updatedByUserId":{"type":"string"},"status":{"type":"string","enum":["Published","Hidden"]},"internalUrl":{"type":"string"},"externalUrl":{"type":"string"},"externalFQDNType":{"type":"integer","format":"int32"},"nestedApps":{"type":"array","items":{"$ref":"#/components/schemas/NestedApplication"}}}}]},"ApplicationUserLoginActivity":{"type":"object","description":"Application User Login  Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"applicationName":{"type":"string"},"applicationLoginUsername":{"type":"string"},"externalUri":{"type":"string"},"internalUri":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"sourceIp":{"type":"string"}}}]},"ApplicationVendorLoginActivity":{"type":"object","description":"Application Vendor Login Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"applicationId":{"type":"string"},"applicationName":{"type":"string"},"applicationLoginUsername":{"type":"string"},"externalUri":{"type":"string"},"internalUri":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"sourceIp":{"type":"string"}}}]},"BaseActivity":{"type":"object","properties":{"id":{"type":"string"},"time":{"type":"integer","format":"int64"},"initiatedById":{"type":"string"},"initiatedByName":{"type":"string"},"initiatedByRole":{"type":"string"}},"description":"Base Activity, presented common fields, contained in every subclass model. The field's model may be any subclass of 'BaseActivity', depended on 'activityType' value. Model name is a concatenation of two 'activityType' value  + 'Activity' suffix, example: 'SiteCreatedActivity'"},"CompanyInviterData":{"type":"object","properties":{"vendorInitialStatus":{"type":"string"},"provisioningType":{"type":"string"},"pcloudProvisioningType":{"type":"string"},"vendorUserName":{"type":"string"},"maxNumInvitedVendors":{"type":"integer","format":"int32"},"startAt":{"type":"integer","format":"int64"},"expiredAt":{"type":"integer","format":"int64"},"emailDomains":{"type":"array","items":{"type":"string"}},"allGroups":{"type":"boolean"},"canCreateGroups":{"type":"boolean"},"canInviteVendorManagers":{"type":"boolean"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/GroupData"}},"apps":{"type":"array","items":{"$ref":"#/components/schemas/VendorApp"}},"allApps":{"type":"boolean"}},"description":"Company Inviter Data"},"CompanyInviterUpdatedActivity":{"type":"object","description":"Company Inviter Update Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"updatedUserId":{"type":"string"},"updatedUserName":{"type":"string"},"updatedUserRole":{"type":"string"},"updatedUserType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]},"oldData":{"$ref":"#/components/schemas/CompanyInviterData"},"updatedData":{"$ref":"#/components/schemas/CompanyInviterData"}}}]},"ConnectorCreatedActivity":{"type":"object","description":"Connector Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"}}}]},"ConnectorDeletedActivity":{"type":"object","description":"Connector Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"}}}]},"ConnectorInitializationExtendedActivity":{"type":"object","description":"Connector Initialization Extended  Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"}}}]},"ConnectorInitializedActivity":{"type":"object","description":"Connector Initialized Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"}}}]},"ConnectorLdapInitializedActivity":{"type":"object","description":"Connector Ldap Initialized Activity","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"},"hostname":{"type":"string"},"certificate":{"type":"string"},"oldHostname":{"type":"string"}}}]},"ConnectorLdapStoppedActivity":{"type":"object","description":"Connector Ldap Stopped Activity","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"},"hostname":{"type":"string"},"certificate":{"type":"string"}}}]},"ConnectorLdapUpdatedActivity":{"type":"object","description":"Connector Ldap Updated Activity","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"},"hostname":{"type":"string"},"certificate":{"type":"string"},"oldCertificate":{"type":"string"},"passwordChanged":{"type":"boolean"}}}]},"ConnectorUpdatedActivity":{"type":"object","description":"Connector Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"},"connectorId":{"type":"string"},"connectorName":{"type":"string"}}}]},"DirectAccessConnectionDeniedActivity":{"type":"object","description":"Direct Access Connection Denied Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"connectionId":{"type":"string"},"appId":{"type":"string"},"appName":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"externalFQDN":{"type":"string"},"reason":{"type":"string"}}}]},"DirectAccessUserResponseActivity":{"type":"object","description":"Direct Access User Response Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"connectionId":{"type":"string"},"appId":{"type":"string"},"appName":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"externalFQDN":{"type":"string"},"approved":{"type":"boolean"},"sourceHostName":{"type":"string"},"accountId":{"type":"string"}}}]},"GroupData":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"}},"description":"Company Inviter Data"},"GroupsCreatedActivity":{"type":"object","description":"Groups Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"}},"provisioningType":{"type":"string"}}}]},"GroupsDeletedActivity":{"type":"object","description":"Groups Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"}},"provisioningType":{"type":"string"}}}]},"GroupsUpdatedActivity":{"type":"object","description":"Groups Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"}},"provisioningType":{"type":"string"}}}]},"IdaptiveRoleSyncActivity":{"type":"object","description":"Idaptive Role Sync Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"deletedEmptyRoles":{"type":"array","items":{"type":"string"}},"deletedMissingRoles":{"type":"array","items":{"type":"string"}}}}]},"IdaptiveVendorSyncActivity":{"type":"object","description":"Idaptive Vendor Sync Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"vendorId":{"type":"string"},"vendorUserName":{"type":"string"},"vendorLoginName":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"startAt":{"type":"integer","format":"int64"},"expiredAt":{"type":"integer","format":"int64"},"roles":{"type":"array","items":{"type":"string"}},"deletedMissingRoles":{"type":"array","items":{"type":"string"}}}}]},"LicenseUpdatedActivity":{"type":"object","description":"License Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"OfflineAccessUserViewedPasswordActivity":{"type":"object","description":"Offline Access User Viewed Password Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"appId":{"type":"string"},"appName":{"type":"string"},"appUrl":{"type":"string"},"appAuthMethod":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"},"platformName":{"type":"string"},"platformId":{"type":"string"},"safeName":{"type":"string"},"address":{"type":"string"},"lastAccessed":{"type":"integer","format":"int64"},"lastSynced":{"type":"integer","format":"int64"}}}]},"ServiceAccountActivatedActivity":{"type":"object","description":"Service Account Activated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"serviceAccountId":{"type":"string"},"serviceAccountName":{"type":"string"},"serviceAccountRole":{"type":"string"},"serviceAccountType":{"type":"string"},"status":{"type":"string"}}}]},"ServiceAccountCreatedActivity":{"type":"object","description":"Service Account Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"createdByUserId":{"type":"string"},"serviceAccountId":{"type":"string"},"serviceAccountName":{"type":"string"},"serviceAccountRole":{"type":"string"},"serviceAccountType":{"type":"string"},"status":{"type":"string"},"role":{"type":"string"}}}]},"ServiceAccountDeactivatedActivity":{"type":"object","description":"Service Account Deactivated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"serviceAccountId":{"type":"string"},"serviceAccountName":{"type":"string"},"serviceAccountRole":{"type":"string"},"serviceAccountType":{"type":"string"},"status":{"type":"string"}}}]},"ServiceAccountDeletedActivity":{"type":"object","description":"Service Account Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"serviceAccountId":{"type":"string"},"serviceAccountName":{"type":"string"},"serviceAccountRole":{"type":"string"},"serviceAccountType":{"type":"string"}}}]},"ServiceAccountRoleChangedActivity":{"type":"object","description":"Service Account Role Changed Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"serviceAccountId":{"type":"string"},"serviceAccountName":{"type":"string"},"serviceAccountRole":{"type":"string"},"serviceAccountType":{"type":"string"},"oldRole":{"type":"string"},"newRole":{"type":"string"}}}]},"ServiceAccountUpdatedActivity":{"type":"object","description":"Service Account Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"serviceAccountId":{"type":"string"},"serviceAccountName":{"type":"string"},"serviceAccountRole":{"type":"string"},"serviceAccountType":{"type":"string"},"status":{"type":"string"},"role":{"type":"string"}}}]},"ServiceAccountsAccessChangedActivity":{"type":"object","description":"Service Account Access Changed Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"issuerId":{"type":"string"},"issuerFirstName":{"type":"string"},"issuerLastName":{"type":"string"},"issuerRole":{"type":"string"},"enabled":{"type":"boolean"}}}]},"SettingsUpdatedActivity":{"type":"object","description":"Vendor Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"settingsUpdatedEntryList":{"type":"array","items":{"$ref":"#/components/schemas/SettingsUpdatedEntry"}}}}]},"SettingsUpdatedEntry":{"type":"object","properties":{"field":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"}},"description":"Updated Setting details"},"SiteCreatedActivity":{"type":"object","description":"Site Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"}}}]},"SiteDeletedActivity":{"type":"object","description":"Site Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"}}}]},"SiteUpdatedActivity":{"type":"object","description":"Site Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"}}}]},"TenantAliasUpdatedActivity":{"type":"object","description":"Tenant Alias Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"oldAlias":{"type":"string"},"newAlias":{"type":"string"}}}]},"TenantCreatedActivity":{"type":"object","description":"Tenant Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"aliasName":{"type":"string"}}}]},"TenantLoginActivity":{"type":"object","description":"Tenant Login  Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"userLoginName":{"type":"string"},"loginType":{"type":"string"},"loginTime":{"type":"integer","format":"int64"},"sourceIp":{"type":"string"}}}]},"UserActivatedActivity":{"type":"object","description":"User Activated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"UserChangedUsernameInTenantActivity":{"type":"object","description":"User Changed User Name Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"UserCreatedActivity":{"type":"object","description":"User Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"phoneNumber":{"type":"string"}}}]},"UserDeactivatedActivity":{"type":"object","description":"User Deactivated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"UserDeletedFromTenantActivity":{"type":"object","description":"User Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"UserInvitationCreatedActivity":{"type":"object","description":"User Invitation Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"invitedUserInitialStatus":{"type":"string","enum":["Deactivated"]},"invitationId":{"type":"string"}}}]},"UserJoinedToTenantActivity":{"type":"object","description":"User Joined To Tenant Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"UserRoleChangedActivity":{"type":"object","description":"User Role Changed Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"userName":{"type":"string"},"updatedUserRole":{"type":"string"},"updatedUserType":{"type":"string","enum":["User","Vendor","SupportPerson","ExternalService","Agent","Connector","ExternalIdpUser"]},"updatedUserInviterData":{"$ref":"#/components/schemas/CompanyInviterData"}}}]},"UserUpdatedActivity":{"type":"object","description":"User Update Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phoneOs":{"type":"string"},"phoneModel":{"type":"string"},"appVersion":{"type":"string"}}}]},"VendorActivatedActivity":{"type":"object","description":"Vendor Activated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"VendorApp":{"type":"object","properties":{"siteId":{"type":"string"},"applicationId":{"type":"string"},"policyId":{"type":"string"}},"description":"Vendor Application Data"},"VendorApplication":{"type":"object","properties":{"siteId":{"type":"string"},"applicationId":{"type":"string"},"policyId":{"type":"string"}},"description":"Updated Vendor Application details"},"VendorDeactivatedActivity":{"type":"object","description":"Vendor Deactivated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"VendorDeletedFromTenantActivity":{"type":"object","description":"Vendor Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"VendorInvitationCreatedActivity":{"type":"object","description":"Vendor Invitation Created Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"vendorInitialStatus":{"type":"string","enum":["Activated","RequiresAdminConfirmation"]},"provisioningApplicationLoginUsername":{"type":"string"},"vendorLastName":{"type":"string"},"vendorRole":{"type":"string","enum":["Vendor","ElevatedVendor"]},"vendorCompanyName":{"type":"string"},"vendorEmailAddress":{"type":"string"},"vendorPhoneNumber":{"type":"string"},"invitedByVendorInitialStatus":{"type":"string","enum":["Activated","RequiresAdminConfirmation"]},"vendorProvisioningType":{"type":"string","description":"Invitee's Provisioning Type","enum":["ProvisionedByAlero","ManagedByAdmin","None"]},"invitationAccessStartTime":{"type":"integer","format":"int64"},"invitationAccessEndTime":{"type":"integer","format":"int64"},"vendorFirstName":{"type":"string"},"invitationId":{"type":"string"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/InvitedToApplication"}},"provisioningGroups":{"type":"array","items":{"type":"string"}}}}]},"VendorInvitationDeletedActivity":{"type":"object","description":"Vendor Invitation Deleted Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"VendorJoinedToTenantActivity":{"type":"object","description":"Vendor Joined To Tenant Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"}]},"VendorUpdatedActivity":{"type":"object","description":"Vendor Updated Activity details","allOf":[{"$ref":"#/components/schemas/BaseActivity"},{"type":"object","properties":{"updatedUserName":{"type":"string"},"updatedUserRole":{"type":"string"},"updatedUserType":{"type":"string","enum":["USER","VENDOR","SUPPORT_PERSON","EXTERNAL_SERVICE","AGENT","CONNECTOR","EXTERNAL_IDP_USER","SWS_USER","INVALID"]},"updatedInTenantUsername":{"type":"string"},"expiredAt":{"type":"integer","format":"int64"},"startAt":{"type":"integer","format":"int64"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/VendorApplication"}},"provisioningType":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}}}}]}},"securitySchemes":{"bearerScheme":{"type":"http","name":"bearerScheme","scheme":"Bearer"}}}}