{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:visier-user-management/user-management-assign-permissions":{"post":{"operationId":"open_data_visier_user_management_user_management_assign_permissions","summary":"Assign permissions to users","description":"PUT /v1/admin/permissions/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-remove-permissions":{"post":{"operationId":"open_data_visier_user_management_user_management_remove_permissions","summary":"Remove permissions from users","description":"DELETE /v1/admin/permissions/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-permission-assigned-users":{"get":{"operationId":"open_data_visier_user_management_user_management_get_permission_assigned_users","summary":"Retrieve users that are assigned a specific permission","description":"GET /v1/admin/permissions/{permissionId}/users","tags":["open-data"],"parameters":[{"name":"permissionId","in":"query","required":true,"description":"The unique identifier of the permission you want to retrieve users for.","schema":{"type":"string","description":"The unique identifier of the permission you want to retrieve users for."}},{"name":"includeUserGroups","in":"query","required":false,"description":"If true, the response returns a list of all users that are assigned the permission, including users that are assigned the permission…","schema":{"type":"boolean","description":"If true, the response returns a list of all users that are assigned the permission, including users that are assigned the permission…"}},{"name":"tenantFilter","in":"query","required":false,"description":"Specify the tenant to retrieve the list of users from.","schema":{"type":"string","description":"Specify the tenant to retrieve the list of users from."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return. The maximum number of tenants to retrieve is 100.","schema":{"type":"integer","description":"The number of results to return. The maximum number of tenants to retrieve is 100."}},{"name":"start","in":"query","required":false,"description":"The index to start retrieving results from, also known as offset. The index begins at 0.","schema":{"type":"integer","description":"The index to start retrieving results from, also known as offset. The index begins at 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-all-user-groups":{"get":{"operationId":"open_data_visier_user_management_user_management_get_all_user_groups","summary":"Retrieve a list of all user groups","description":"GET /v1/admin/user-groups","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve the list of user groups from.","schema":{"type":"string","description":"Specify the tenant to retrieve the list of user groups from."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return. The maximum number of users to retrieve is 1000.","schema":{"type":"integer","description":"The number of results to return. The maximum number of users to retrieve is 1000."}},{"name":"start","in":"query","required":false,"description":"The index to start retrieving results from, also known as offset.","schema":{"type":"integer","description":"The index to start retrieving results from, also known as offset."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-assign-permissions-to-user-groups":{"post":{"operationId":"open_data_visier_user_management_user_management_assign_permissions_to_user_groups","summary":"Assign permissions to user groups","description":"PUT /v1/admin/user-groups/permissions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-revoke-permissions-from-user-groups":{"post":{"operationId":"open_data_visier_user_management_user_management_revoke_permissions_from_user_groups","summary":"Remove permissions from user groups","description":"DELETE /v1/admin/user-groups/permissions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-add-users-to-user-group":{"post":{"operationId":"open_data_visier_user_management_user_management_add_users_to_user_group","summary":"Assign users to user groups","description":"PUT /v1/admin/user-groups/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-remove-users-from-user-group":{"post":{"operationId":"open_data_visier_user_management_user_management_remove_users_from_user_group","summary":"Remove users from user groups","description":"DELETE /v1/admin/user-groups/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-user-group-users":{"get":{"operationId":"open_data_visier_user_management_user_management_get_user_group_users","summary":"Retrieve a list of user group users","description":"GET /v1/admin/user-groups/{userGroupId}/users","tags":["open-data"],"parameters":[{"name":"userGroupId","in":"query","required":true,"description":"The ID of user group.","schema":{"type":"string","description":"The ID of user group."}},{"name":"tenantFilter","in":"query","required":false,"description":"Specifies the tenant to retrieve the list of users from.","schema":{"type":"string","description":"Specifies the tenant to retrieve the list of users from."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return. The maximum number of tenants to retrieve is 100.","schema":{"type":"integer","description":"The number of results to return. The maximum number of tenants to retrieve is 100."}},{"name":"start","in":"query","required":false,"description":"The index to start retrieving results from, also known as offset. The index begins at 0.","schema":{"type":"integer","description":"The index to start retrieving results from, also known as offset. The index begins at 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-all-users":{"get":{"operationId":"open_data_visier_user_management_user_management_get_all_users","summary":"Retrieve a list of all users","description":"GET /v1/admin/users","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve a list of users from.","schema":{"type":"string","description":"Specify the tenant to retrieve a list of users from."}},{"name":"assignedProfiles","in":"query","required":false,"description":"If true, the response returns a list of the user's assigned profiles.","schema":{"type":"boolean","description":"If true, the response returns a list of the user's assigned profiles."}},{"name":"assignedPermissions","in":"query","required":false,"description":"If true, the response returns the user's assigned permissions.","schema":{"type":"boolean","description":"If true, the response returns the user's assigned permissions."}},{"name":"assignedUserGroups","in":"query","required":false,"description":"If true, the response returns the user's assigned user groups.","schema":{"type":"boolean","description":"If true, the response returns the user's assigned user groups."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return. The maximum number of users to retrieve is 1000.","schema":{"type":"integer","description":"The number of results to return. The maximum number of users to retrieve is 1000."}},{"name":"start","in":"query","required":false,"description":"The index to start retrieving results from, also known as offset. The index begins at 0.","schema":{"type":"integer","description":"The index to start retrieving results from, also known as offset. The index begins at 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-add-user":{"post":{"operationId":"open_data_visier_user_management_user_management_add_user","summary":"Add a user","description":"POST /v1/admin/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to create a user in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-user-detail":{"get":{"operationId":"open_data_visier_user_management_user_management_get_user_detail","summary":"Retrieve a user's details","description":"GET /v1/admin/users/{userId}","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"The ID of the user you want to retrieve.","schema":{"type":"string","description":"The ID of the user you want to retrieve."}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve a user from.","schema":{"type":"string","description":"Specify the tenant to retrieve a user from."}},{"name":"assignedProfiles","in":"query","required":false,"description":"If true, the response returns a list of the user's assigned profiles.","schema":{"type":"boolean","description":"If true, the response returns a list of the user's assigned profiles."}},{"name":"assignedPermissions","in":"query","required":false,"description":"If true, the response returns the user's assigned permissions.","schema":{"type":"boolean","description":"If true, the response returns the user's assigned permissions."}},{"name":"assignedUserGroups","in":"query","required":false,"description":"If true, the response returns the user's assigned user groups.","schema":{"type":"boolean","description":"If true, the response returns the user's assigned user groups."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-update-user":{"post":{"operationId":"open_data_visier_user_management_user_management_update_user","summary":"Update a user","description":"PUT /v1/admin/users/{userId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","body"],"properties":{"userId":{"type":"string","description":"The ID of the user you want to update."},"tenantCode":{"type":"string","description":"Specify the tenant to update a user in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-delete-user":{"post":{"operationId":"open_data_visier_user_management_user_management_delete_user","summary":"Delete a user","description":"DELETE /v1/admin/users/{userId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of the user you want to delete."},"tenantCode":{"type":"string","description":"Specify the tenant to delete a user in."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-v2-add-users":{"post":{"operationId":"open_data_visier_user_management_user_management_v2_add_users","summary":"Add users","description":"POST /v2/admin/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to create a user in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-v2-update-users":{"post":{"operationId":"open_data_visier_user_management_user_management_v2_update_users","summary":"Update users","description":"PUT /v2/admin/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to update a user in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-v2-delete-users":{"post":{"operationId":"open_data_visier_user_management_user_management_v2_delete_users","summary":"Delete users","description":"DELETE /v2/admin/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to delete a user in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-application-logs-xlsx":{"get":{"operationId":"open_data_visier_user_management_user_management_get_application_logs_xlsx","summary":"Retrieve the Application Logs","description":"GET /v1/admin/users/reports/application-logs","tags":["open-data"],"parameters":[{"name":"startTime","in":"query","required":false,"description":"An inclusive date-time to start retrieving Application Logs from.","schema":{"type":"string","description":"An inclusive date-time to start retrieving Application Logs from."}},{"name":"endTime","in":"query","required":false,"description":"An exclusive date-time to stop retrieving Application Logs from.","schema":{"type":"string","description":"An exclusive date-time to stop retrieving Application Logs from."}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve Application Logs from.","schema":{"type":"string","description":"Specify the tenant to retrieve Application Logs from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-data-security-report-xlsx":{"get":{"operationId":"open_data_visier_user_management_user_management_get_data_security_report_xlsx","summary":"Retrieve the Data Security Report","description":"GET /v1/admin/users/{userId}/reports/data-security","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"The ID of the user to retrieve the report for.","schema":{"type":"string","description":"The ID of the user to retrieve the report for."}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve the Data Security Report from.","schema":{"type":"string","description":"Specify the tenant to retrieve the Data Security Report from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-profile-assignments-xlsx":{"get":{"operationId":"open_data_visier_user_management_user_management_get_profile_assignments_xlsx","summary":"Retrieve user profile assignments in XLSX format","description":"GET /v1/admin/users/reports/profile-assignments","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve profile assignments from.","schema":{"type":"string","description":"Specify the tenant to retrieve profile assignments from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-user-permissions-xlsx":{"get":{"operationId":"open_data_visier_user_management_user_management_get_user_permissions_xlsx","summary":"Retrieve user permissions in XLSX format","description":"GET /v1/admin/users/reports/permission-assignments","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve the permission assignments report from.","schema":{"type":"string","description":"Specify the tenant to retrieve the permission assignments report from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-user-management/user-management-get-all-permissions-xlsx":{"get":{"operationId":"open_data_visier_user_management_user_management_get_all_permissions_xlsx","summary":"Retrieve a list of all permissions in XLSX format","description":"GET /v1/admin/users/reports/permissions-list","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve permissions from.","schema":{"type":"string","description":"Specify the tenant to retrieve permissions from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}