{"openapi":"3.0.0","paths":{"/api/v1/organizations/{organizationId}":{"get":{"description":"This endpoint is used to get an organization by its ID. It returns the organization's details, including its name, unique name, status, system language, etc.","operationId":"publicGetOrganization","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicOrganizationResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get an organization","tags":["Organizations"]}},"/api/v1/organizations/{organizationId}/people":{"get":{"description":"List organization people (data aggregated from SaaS).
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetPeople","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"types","required":false,"in":"query","description":"Filter results by type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleType"}}},{"name":"statuses","required":false,"in":"query","description":"Filter results by status. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleStatus"}}},{"name":"keyword","required":false,"in":"query","description":"Filter results by username, email or displayName.","schema":{"type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a specific field.","schema":{"$ref":"#/components/schemas/PeopleSortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"includePeopleWithNoAccounts","required":false,"in":"query","description":"By default, won't return people who have no SaaS accounts. This flag will override that behavior.","schema":{"type":"boolean"}},{"name":"serviceIds","required":false,"in":"query","description":"Filter people who own some specific SaaS accounts. Accepts multiple options.","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}},{"name":"status","required":false,"in":"query","description":"Filter results by status. Note: please use `statuses` instead, this property is deprecated and will be removed in a future version.","deprecated":true,"schema":{"$ref":"#/components/schemas/PeopleStatus"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetPeopleResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List organization people","tags":["People"]}},"/api/v1/organizations/{organizationId}/people/{peopleId}":{"get":{"operationId":"publicGetPerson","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"peopleId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPeopleResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get a person in the organization","tags":["People"]}},"/api/v1/organizations/{organizationId}/people/merge":{"post":{"deprecated":true,"description":"Batch merge people in pairs. Each pair consists of: a `fromPeopleId`, which represents a person of type `UNKNOWN` or `GUEST` to be merged into `toPeopleId`, which represents a person of type `GUEST` or `EMPLOYEE` or `SYSTEM`.","operationId":"publicMergePeople","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMergePeopleRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetPeopleResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Merge people in batch","tags":["People"]}},"/api/v1/organizations/{organizationId}/people/unmerge":{"post":{"deprecated":true,"description":"Unmerge previously merged people.","operationId":"publicUnmergePeople","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUnmergePeopleRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetPeopleResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Unmerges people","tags":["People"]}},"/api/v1/organizations/{organizationId}/people/{peopleId}/accounts":{"get":{"description":"List all SaaS accounts belong to a person.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetPeopleAccounts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"peopleId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"role","required":false,"in":"query","description":"Filter results by role (not all SaaS support this filter).
`admin` - only SaaS admin accounts
`guest` - only SaaS guest accounts
`other` - SaaS accounts that are neither admin nor guest","schema":{"$ref":"#/components/schemas/PeopleAccountRole"}},{"name":"twoFa","required":false,"in":"query","description":"Filter results by two-factor authentication availability.","schema":{"type":"boolean"}},{"name":"keyword","required":false,"in":"query","description":"Filter results by SaaS name or workspace name (partial match supported).","schema":{"type":"string"}},{"name":"serviceIds","required":false,"in":"query","description":"Filter results by service ID. Accepts multiple options.","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}},{"name":"workspaceIds","required":false,"in":"query","description":"Filter results by workspace ID. Accepts multiple options.","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a specific field.","schema":{"$ref":"#/components/schemas/PeopleAccountSortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"licenses","required":false,"in":"query","description":"Filter results by license. Accepts multiple options.","schema":{"example":["license1","license2"],"type":"array","items":{"type":"string"}}},{"name":"status","required":false,"in":"query","description":"Filter results by status.","schema":{"$ref":"#/components/schemas/PeopleStatus"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetPeopleAccountsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List all SaaS accounts belonging to a person","tags":["People"]}},"/api/v1/organizations/{organizationId}/users":{"get":{"description":"This endpoint is used to list all users in an organization, including their role, status, and other details. List all organization users.
Pagination: [Page-based](#section/Page-based)","operationId":"publicGetUsers","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"query","required":false,"in":"query","description":"Support searching by name, email, role","schema":{"example":"John Doe","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number to paginate through results.","schema":{"example":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned.","schema":{"example":10,"type":"number"}},{"name":"sortField","required":false,"in":"query","description":"Sort results by a field.","schema":{"$ref":"#/components/schemas/UserSortField"}},{"name":"order","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicListOrganizationUsersResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List organization users","tags":["Users"]}},"/api/v1/organizations/{organizationId}/users/admin-count":{"get":{"description":"Get the number of users with admin role in the organization.","operationId":"publicGetAdminCount","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicTotalAdminResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get the number of users with admin role","tags":["Users"]}},"/api/v1/organizations/{organizationId}/users/{userId}":{"patch":{"description":"Update an organization's user. Currently only user's role is allowed to be updated.","operationId":"publicUpdateUser","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"userId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateOrganizationUserRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicOrganizationUserResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Update an organization's user","tags":["Users"]}},"/api/v1/organizations/{organizationId}/services":{"get":{"description":"List all integrated services (SaaS) in the organization.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetOrganizationServices","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"keyword","required":false,"in":"query","description":"Support searching by service name, workspace name or service unique name","schema":{"type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a specific field.","schema":{"$ref":"#/components/schemas/ServiceSortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetOrganizationServicesListResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List organization services","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/engagement-scores":{"get":{"operationId":"publicGetEngagementScores","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceUniqueNames","required":false,"in":"query","description":"Comma separated service unique names. Accepts multiple options.","schema":{"example":"github,gitlab","type":"string"}},{"name":"categoryIds","required":false,"in":"query","description":"Comma separated category ids. Accepts multiple options.","schema":{"example":"1,2,3","type":"string"}},{"name":"startDate","required":true,"in":"query","description":"Start date for the engagement scores calculation.","schema":{"format":"date","example":"2023-01-01","type":"string"}},{"name":"endDate","required":true,"in":"query","description":"End date for the engagement scores calculation.","schema":{"format":"date","example":"2023-02-01","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetEngagementScoresResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Returns the engagement scores of services in an organization","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/unused-resources":{"get":{"operationId":"publicGetUnusedResources","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a specific field.","schema":{"$ref":"#/components/schemas/GetUnusedResourcesSortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetUnusedResourcesResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get retired and inactive accounts of all services in an organization","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/accounts":{"get":{"description":"List all SaaS accounts of a service.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetServiceAccounts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"keyword","required":false,"in":"query","description":"Partial match for name or email address.","schema":{"type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a specific field.","schema":{"$ref":"#/components/schemas/PeopleAccountSortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"workspaceIds","required":false,"in":"query","description":"Filter results by workspaceIds. Accepts multiple options.","schema":{"example":[1],"type":"array","items":{"type":"number"}}},{"name":"twoFa","required":false,"in":"query","description":"Filter results by two-factor authentication availability.","schema":{"type":"boolean"}},{"name":"roles","required":false,"in":"query","description":"Filter results by role (not all SaaS support this filter).
`admin` - only SaaS admin accounts
`guest` - only SaaS guest accounts
`other` - SaaS accounts that are neither admin nor guest. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleAccountRole"}}},{"name":"serviceRoles","required":false,"in":"query","description":"Filter results by role in the SaaS. Accepts multiple options.","schema":{"example":["role1","role2"],"type":"array","items":{"type":"string"}}},{"name":"types","required":false,"in":"query","description":"Filter results by type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleType"}}},{"name":"employeeTypes","required":false,"in":"query","description":"Filter results by type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeType"}}},{"name":"statuses","required":false,"in":"query","description":"Filter results by status. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleStatus"}}},{"name":"employeeStatuses","required":false,"in":"query","description":"Filter results by type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeStatus"}}},{"name":"includeDeleted","required":false,"in":"query","description":"Some services contain accounts marked as `deleted`. By default this API does not return those accounts. Setting this flag to `true` will override the default behavior.","schema":{"type":"boolean"}},{"name":"expandIdentities","required":false,"in":"query","description":"All people accounts are linked to an identity. By default this API does not return the related identity. Setting this flag to `true` will override the default behavior.","schema":{"type":"boolean"}},{"name":"onlyInactive","required":false,"in":"query","description":"Show accounts that have been inactive for a while","schema":{"type":"boolean"}},{"name":"licenses","required":false,"in":"query","description":"Filter results by license. Accepts multiple options.","schema":{"example":["license1","license2"],"type":"array","items":{"type":"string"}}},{"name":"alertType","required":false,"in":"query","description":"Filter results by alert type. Required when `alertStatus` is set.","schema":{"$ref":"#/components/schemas/AlertType"}},{"name":"alertStatus","required":false,"in":"query","description":"Filter results by alert status.","schema":{"$ref":"#/components/schemas/AlertStatus"}},{"name":"includeAccountMemo","required":false,"in":"query","description":"Whether to include account memos in the response","schema":{"type":"boolean"}},{"name":"workspaceId","required":false,"in":"query","description":"Filter results by workspaceId. Note: please use `workspaceIds` instead, this property is deprecated and will be removed in a future version.","deprecated":true,"schema":{"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter results by status. Note: please use `statuses` instead, this property is deprecated and will be removed in a future version.","deprecated":true,"schema":{"$ref":"#/components/schemas/PeopleStatus"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceAccountsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List all SaaS accounts of a service","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/accounts/memos/{accountId}":{"put":{"description":"Create or update memo for a service account","operationId":"publicCreateOrUpdateAccountMemo","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateServiceAccountMemoRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateServiceAccountMemoResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create/update account memo","tags":["Services"]},"delete":{"description":"Remove account memo","operationId":"publicRemoveAccountMemo","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Remove account memo","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/files":{"get":{"description":"Get files for a service in an organization.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetServicesFiles","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"keyword","required":false,"in":"query","description":"Partial match for name.","schema":{"type":"string"}},{"name":"sharingStatus","required":false,"in":"query","description":"Filter results by sharing status.","schema":{"$ref":"#/components/schemas/FileSharingStatus"}},{"name":"fileType","required":false,"in":"query","description":"Filter results by file type.","schema":{"$ref":"#/components/schemas/FileType"}},{"name":"owners","required":false,"in":"query","description":"Filter results by owners.","schema":{"example":["John Doe","Jane Doe"],"type":"array","items":{"type":"string"}}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a field.","schema":{"$ref":"#/components/schemas/ServiceFilesSortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"workspaceId","required":false,"in":"query","description":"Filter results by workspace ID.","schema":{"example":123,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetServiceFilesResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get files for a service in an organization","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/files/summary":{"get":{"description":"Get summary of files for a service in an organization","operationId":"publicGetServicesFilesSummary","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetServiceFilesSummaryResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get summary of files for a service in an organization","tags":["Services"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/files/safe-lists":{"get":{"description":"Retrieve a paginated list of safe lists across all workspaces of a service.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetServiceSafeLists","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetServiceFileSafeListsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List safe lists for a service","tags":["Services"]}},"/api/v1/organizations/{organizationId}/workspaces":{"get":{"description":"List all organization workspaces
Simple non-nested objects are serialized as `paramName[prop1]=value1¶mName[prop2]=value2&..` following the `deepObject` serialization style as defined in OpenAPI specification.
Example for `workspaceMeta` parameter: `workspaceMeta[businessImpactLevel]=low&workspaceMeta[piiEnabled]=true`
","operationId":"publicGetWorkspaces","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"ids","required":false,"in":"query","description":"Filter workspaces by id. Accepts multiple options.","schema":{"type":"array","items":{"type":"number"}}},{"name":"serviceId","required":false,"in":"query","description":"Filter workspaces by service id.","schema":{"type":"number"}},{"name":"isSpendingMaster","required":false,"in":"query","description":"Filter workspaces by spending master status.","schema":{"type":"boolean"}},{"name":"workspaceMeta","required":false,"in":"query","description":"Filter workspaces by meta data.","schema":{"$ref":"#/components/schemas/WorkspaceMetaQueryDto"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkspaceResponseDto"}}}}}},"security":[{"API-Key":[]}],"summary":"List organization workspaces","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}":{"get":{"description":"Get the details of a workspace in the organization","operationId":"publicGetWorkspace","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicWorkspaceResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get an organization workspace","tags":["Workspaces"]},"delete":{"description":"Delete a workspace in the organization","operationId":"publicDeleteWorkspace","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicWorkspaceResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Delete an organization workspace","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/workspaces/custom":{"post":{"description":"Create a custom workspace with serviceId or service name","operationId":"publicCreateCustomWorkspace","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicCustomWorkspaceWithAdminaServiceDto"},{"$ref":"#/components/schemas/PublicCustomWorkspaceWithServiceMasterDto"},{"$ref":"#/components/schemas/PublicCustomWorkspaceWithCustomServiceDto"}]}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateCustomWorkspaceResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create custom service and workspace","tags":["Custom Service and Workspace"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/workspace-meta":{"get":{"description":"Get the metadata details of a workspace in the organization","operationId":"publicGetWorkspaceMeta","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicWorkspaceMetaResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get workspace metadata","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/provisioning-meta":{"get":{"operationId":"publicGetProvisioningMeta","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"lang","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetProvisioningMetaResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get provisioning meta for workspace of a service","tags":["Workspace Accounts"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/{fileId}/permissions":{"get":{"description":"Get detailed permissions information for a specific file in a workspace","operationId":"publicGetWorkspaceFilePermissions","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"fileId","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkspaceFilePermissionsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get permissions for a file in a workspace","tags":["Workspaces"]}},"/api/v1/services":{"get":{"description":"List all available SaaS applications in Admina.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetServices","parameters":[{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"keyword","required":false,"in":"query","description":"Search keyword for service name or unique name","schema":{"example":"google","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicListServicesResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List services","tags":["Services"]}},"/api/v1/organizations/{organizationId}/spends/history-by-service":{"get":{"operationId":"publicGetServicesSpends","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceUniqueNames","required":false,"in":"query","description":"Comma separated service unique names. Accepts multiple options.","schema":{"example":"github,gitlab","type":"string"}},{"name":"categoryIds","required":false,"in":"query","description":"Comma separated category ids. Accepts multiple options.","schema":{"example":"1,2,3","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Filter spends by start date.","schema":{"format":"date","example":"2020-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Filter spends by end date.","schema":{"format":"date","example":"2023-01-01","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetSpendsByServicesResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get spends by services","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/spends/history-by-month":{"get":{"operationId":"publicGetMonthlySpends","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"startDate","required":true,"in":"query","description":"Filter spends by start date.","schema":{"format":"date","example":"2022-01-01","type":"string"}},{"name":"endDate","required":true,"in":"query","description":"Filter spends by end date.","schema":{"format":"date","example":"2022-03-31","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetMonthlySpendsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get spends by month","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/spends/import":{"post":{"operationId":"publicImportSpends","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSpendsRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IggreRequestResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Import spends","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/spends/csv/import":{"post":{"description":"Upload and process CSV file containing spending data","operationId":"publicImportSpendCsv","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"Returns requestId for tracking import progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IggreRequestResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Import spending data CSV file","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/spends/csv/export":{"get":{"description":"Request CSV export of spending data - returns requestId for tracking progress and download","operationId":"publicExportSpendCsv","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"startDate","required":false,"in":"query","schema":{"example":"2022-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","schema":{"example":"2022-03-31","type":"string"}},{"name":"serviceNameOrDescription","required":false,"in":"query","schema":{"example":"Zoom","type":"string"}},{"name":"serviceUniqueNames","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"source","required":false,"in":"query","schema":{"example":"123","type":"string"}},{"name":"showUnmatched","required":false,"in":"query","schema":{"example":false,"type":"boolean"}},{"name":"contractId","required":false,"in":"query","schema":{"example":1,"type":"number"}},{"name":"maxBillingStartDate","required":false,"in":"query","schema":{"example":"2022-01-01","type":"string"}},{"name":"minBillingEndDate","required":false,"in":"query","schema":{"example":"2022-03-31","type":"string"}},{"name":"spendIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"sortBy","required":false,"in":"query","schema":{"example":"amount","type":"string"}},{"name":"sortOrder","required":false,"in":"query","schema":{"example":"desc","type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"}},{"name":"serviceIds","required":false,"in":"query","description":"authz","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns requestId for tracking export progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IggreRequestResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Export spending data as CSV","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/accounts/custom":{"post":{"operationId":"publicSaveCustomAccounts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateCustomAccountBulkRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create, update and delete custom workspace SaaS accounts data","tags":["Custom Service and Workspace"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/accounts":{"post":{"description":"Provision an account for a user in a workspace.","operationId":"publicCreateServiceAccount","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"lang","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateAccountRequestDto"}}}},"responses":{"200":{"description":"Please use the `/api/v1/organizations/{organizationId}/requests` endpoint to retrieve the status of the deprovisioning request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreateAccountResponseDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorListResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create an SaaS account","tags":["Workspace Accounts"]}},"/api/v1/organizations/{organizationId}/workspace/{workspaceId}/accounts/custom":{"post":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/accounts/custom` endpoint instead.","operationId":"publicSaveCustomAccounts_Deprecated","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateCustomAccountBulkRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create, update and delete custom workspace SaaS accounts data","tags":["Custom Service and Workspace"]}},"/api/v1/organizations/{organizationId}/workspace/{workspaceId}/accounts":{"post":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/accounts` endpoint instead.","operationId":"publicCreateServiceAccount_Deprecated","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"lang","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateAccountRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreateAccountResponseDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorListResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create an SaaS account","tags":["Workspace Accounts"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists":{"post":{"description":"Create a new safe list of files, domains, emails, or groups for a workspace.","operationId":"publicCreateWorkspaceSafeList","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateWorkspaceFileSafeListRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create a safe list for a workspace","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/bulk":{"patch":{"description":"Add entries to multiple safe lists of a workspace in a single request.","operationId":"publicBulkUpdateWorkspaceSafeList","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBulkUpdateWorkspaceFileSafeListRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Bulk update safe lists for a workspace","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}":{"patch":{"description":"Update an existing safe list. The request body supports adding or removing entries in the same call.","operationId":"publicUpdateWorkspaceSafeList","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"safeListId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateWorkspaceFileSafeListRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Update a safe list for a workspace","tags":["Workspaces"]},"delete":{"description":"Delete an existing safe list from a workspace.","operationId":"publicDeleteWorkspaceSafeList","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"safeListId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Delete a safe list for a workspace","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}/{safeListType}":{"get":{"description":"Retrieve a paginated list of entries (files, domains, or emails) belonging to a specific safe list.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetWorkspaceSafeList","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"safeListId","required":true,"in":"path","schema":{"type":"string"}},{"name":"safeListType","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetSafeListResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get entries from a safe list","tags":["Workspaces"]}},"/api/v1/organizations/{organizationId}/usage-optimization/unutilized-resources":{"get":{"operationId":"publicGetUnutilizedResources","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"serviceUniqueName","required":false,"in":"query","description":"The unique name of the service.","schema":{"example":"datadog","type":"string"}},{"name":"resourceType","required":false,"in":"query","description":"The type of the resource.","schema":{"$ref":"#/components/schemas/UsageBasedResourceType"}},{"name":"workspaceId","required":false,"in":"query","description":"The ID of the workspace.","schema":{"example":12345678,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetUnutilizedResourcesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get unutilized resources","tags":["Usage Optimization"]}},"/api/v1alpha/organizations/{organizationId}/devices":{"get":{"deprecated":true,"operationId":"publicGetDevicesV1Alpha","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"locale","required":true,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}},{"name":"type","required":false,"in":"query","schema":{"$ref":"#/components/schemas/DeviceType"}},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDevicesListResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Return a list of devices with localized values","tags":["Devices"]}},"/api/v1alpha/organizations/{organizationId}/devices/fields/all":{"get":{"deprecated":true,"operationId":"publicGetDeviceFieldsList","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"locale","required":true,"in":"query","description":"Translate the field names and labels to the specified locale.","schema":{"$ref":"#/components/schemas/Locale"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceFieldsListResponseDtoV1Alpha"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Return a list of device fields with localized values","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/search":{"post":{"operationId":"publicSearchDevices","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return per page","schema":{"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Base64-encoded cursor for pagination. Use the cursor from the previous response to get the next page.","schema":{"type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"The `sortBy` value is a string that contains two parts separated by a dot. The first part is either `preset` or `custom` and the second part is the unique field name. Additionally the following fields can be used for sorting: `people.displayName`.","schema":{"example":".","type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order for the results (asc or desc)","schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"expands","required":false,"in":"query","description":"Expand other datasets when fetching devices. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceExpand"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchDevicesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSearchDevicesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Search devices for an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices":{"post":{"operationId":"publicCreateDevice","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateDeviceRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Create a device for an organization","tags":["Devices"]},"get":{"operationId":"publicGetDevices","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"locale","required":true,"in":"query","description":"Translate the field names and labels to the specified locale.","schema":{"$ref":"#/components/schemas/Locale"}},{"name":"type","required":false,"in":"query","description":"Filter by device type.","schema":{"$ref":"#/components/schemas/DeviceType"}},{"name":"status","required":false,"in":"query","description":"Filter by device status.","schema":{"$ref":"#/components/schemas/DeviceStatus"}},{"name":"asset_number","required":false,"in":"query","description":"Filter by asset number.","schema":{"example":"MF-123-01","type":"string"}},{"name":"serial_number","required":false,"in":"query","description":"Filter by serial number.","schema":{"example":"MF4XFR9P7KY","type":"string"}},{"name":"identityId","required":false,"in":"query","description":"Filter by identity Id of the user assigned to this device. `identityId` has precedence over `peopleId`.","schema":{"example":"TALWESJ9WC","type":"string"}},{"name":"peopleId","required":false,"in":"query","description":"Filter by people Id of the user assigned to this device. If `identityId` is present, `peopleId` takes precedence over `identityId`.","schema":{"example":5034567,"type":"number"}},{"name":"expands","required":false,"in":"query","description":"Expand other datasets when fetching devices. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceExpand"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDevicesListResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Return a list of devices with localized values filterable by status, asset number, serial number, and uid (or peopleId)","tags":["Devices"]},"delete":{"operationId":"publicDeleteDevices","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDeleteDevicesBulkRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDeleteDevicesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Delete multiple devices of an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/bulk":{"post":{"operationId":"publicCreateDevices","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateDevicesBulkRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateDevicesBulkListResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Create devices for an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/{deviceId}":{"patch":{"operationId":"updateDevice","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateDeviceRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Update device of an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/stats":{"get":{"operationId":"publicGetDeviceStats","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"type","required":false,"in":"query","schema":{"$ref":"#/components/schemas/DeviceType"}},{"name":"groupId","required":false,"in":"query","description":"Filter stats by device group","schema":{"example":1,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDevicesStatsResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get statistics of devices for an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/insights":{"get":{"operationId":"publicGetDeviceInsights","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"type","required":false,"in":"query","schema":{"$ref":"#/components/schemas/DevicePresetFieldUniqueName"}},{"name":"deviceTypes","required":false,"in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceType"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicDeviceInsightsResponseDto"}}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get insights of devices for an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/device-types":{"get":{"operationId":"publicGetAllowedDeviceTypes","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDevicePresetFieldDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get allowed device types for the organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/workspaces":{"get":{"operationId":"publicGetWorkspacesForDeviceMDM","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceWorkspaceStatusResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get workspaces for device MDM integration","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/fields/custom":{"get":{"operationId":"publicGetDeviceCustomFields","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceCustomFieldsListResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get all custom fields of an organization","tags":["Devices"]},"post":{"operationId":"publicCreateDeviceCustomField","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateDeviceCustomFieldRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceCustomFieldResponseDto"}}}},"409":{"description":"The custom field unique name is already in use."}},"security":[{"API-Key":[]}],"summary":"Create a custom field for an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/fields/custom/{customFieldId}":{"patch":{"operationId":"publicUpdateDeviceCustomField","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"customFieldId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateDeviceCustomFieldRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceCustomFieldResponseDto"}}}},"409":{"description":"The custom field unique name is already in use."}},"security":[{"API-Key":[]}],"summary":"Update a custom field for an organization","tags":["Devices"]},"delete":{"operationId":"publicDeleteDeviceCustomField","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"customFieldId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Delete a custom field for an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/departments":{"get":{"operationId":"publicGetDepartments","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDepartmentsResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"List Departments","tags":["Departments"]}},"/api/v1/organizations/{organizationId}/locations":{"get":{"operationId":"publicGetLocations","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetLocationsResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"List Locations","tags":["Locations"]}},"/api/v1/organizations/{organizationId}/companies":{"get":{"operationId":"publicGetCompanies","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetCompaniesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"List Companies","tags":["Companies"]}},"/api/v1/organizations/{organizationId}/identity":{"post":{"operationId":"publicCreateIdentity","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateIdentityDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityDto"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"examples":{"validation_exception":{"summary":"Request rules are not followed.","value":{"statusCode":400,"errorId":"validation_exception","errorDetails":[{"property":"isManager","constraints":{"isEmpty":"isManager must be empty"}}]}},"identity_invalid_employee_type":{"summary":"The employee type is invalid.","value":{"statusCode":400,"errorId":"identity_invalid_employee_type"}},"identity_invalid_employee_status":{"summary":"The employee status is invalid.","value":{"statusCode":400,"errorId":"identity_invalid_employee_status"}},"identity_duplicated_email":{"summary":"The email is already in use.","value":{"statusCode":400,"errorId":"identity_duplicated_email"}}}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."},"422":{"description":"The custom fields are invalid."}},"security":[{"API-Key":[]}],"summary":"Create a new Identity","tags":["Directory"]},"get":{"operationId":"publicGetIdentities","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"managementTypes","required":false,"in":"query","description":"Filter results by management type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ManagementType"}}},{"name":"types","required":false,"in":"query","description":"Filter results by type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeType"}}},{"name":"statuses","required":false,"in":"query","description":"Filter results by status. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedEmployeeStatus"}}},{"name":"companies","required":false,"in":"query","description":"Filter results by companies. Accepts multiple options.","schema":{"example":["Corp 1","Corp 2"],"type":"array","items":{"type":"string"}}},{"name":"departments","required":false,"in":"query","description":"Filter results by departments. Accepts multiple options.","schema":{"example":["Sales","Marketing"],"type":"array","items":{"type":"string"}}},{"name":"locations","required":false,"in":"query","description":"Filter results by locations. Accepts multiple options.","schema":{"example":["Tokyo","London"],"type":"array","items":{"type":"string"}}},{"name":"keyword","required":false,"in":"query","description":"Filter results by username, identityId, department name, email or displayName (prefix search).","schema":{"type":"string"}},{"name":"contractStartRange","required":false,"in":"query","description":"Filter results by contract start date range. Format: `YYYY-MM-DD:YYYY-MM-DD`, separated by a colon.","schema":{"example":"2023-01-01:2023-12-31","type":"string"}},{"name":"contractEndRange","required":false,"in":"query","description":"Filter results by contract end date range. Format: `YYYY-MM-DD:YYYY-MM-DD`, separated by a colon.","schema":{"example":"2023-01-01:2023-12-31","type":"string"}},{"name":"createdAtRange","required":false,"in":"query","description":"Filter results by created date range. Format: `YYYY-MM-DD:YYYY-MM-DD`, separated by a colon.","schema":{"example":"2023-01-01:2023-12-31","type":"string"}},{"name":"updatedAtRange","required":false,"in":"query","description":"Filter results by updated date range. Format: `YYYY-MM-DD:YYYY-MM-DD`, separated by a colon.","schema":{"example":"2023-01-01:2023-12-31","type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort results by a specific field.","schema":{"$ref":"#/components/schemas/IdentitySortBy"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort results in ascending or descending order. Defaults to `ASC`.","schema":{"example":"ASC","type":"string","enum":["DESC","ASC"]}},{"name":"expands","required":false,"in":"query","description":"Expand other datasets when fetching identities. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityExpand"}}},{"name":"alertTypes","required":false,"in":"query","description":"Filter result by alert type. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertType"}}},{"name":"managerId","required":false,"in":"query","description":"Filter results by managerId.","schema":{"example":"0","type":"string"}},{"name":"serviceId","required":false,"in":"query","description":"Filter results by serviceId.","schema":{"example":"foo","type":"string"}},{"name":"hasHRM","required":false,"in":"query","description":"Filter results by HRM (employee master) linkage. When true, returns only UIDs with HRM linkage. When not provided, no filtering is applied.","schema":{"example":true,"type":"boolean"}},{"name":"haveAssignedDevice","required":false,"in":"query","description":"Filter results by identities that have at least one assigned device","schema":{"example":true,"type":"boolean"}},{"name":"haveSaasAccount","required":false,"in":"query","description":"Filter results by identities that have at least one SaaS account","schema":{"example":true,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetIdentitiesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"List Identities","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/check":{"get":{"operationId":"publicCheckIdentityManagementType","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"email","required":false,"in":"query","description":"Email of the new Identity to check","schema":{"type":"string"}},{"name":"identityId","required":false,"in":"query","description":"Identity Id to be checked","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCheckIdentitiesManagementTypeResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Check Identity management type","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/stats":{"get":{"operationId":"publicGetIdentitiesStats","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetIdentitiesStatisticsResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Identities Stats","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/{identityId}/history":{"get":{"operationId":"publicGetIdentityHistory","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"default":10,"type":"number"}},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityHistoryByChangeResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get an Identity History","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/{identityId}/archive":{"put":{"operationId":"publicUpdateIdentityArchive","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityDto"}}}}},"security":[{"API-Key":[]}],"summary":"Toggle Identity Archive flag","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/{identityId}/unregister":{"put":{"operationId":"publicUpdateIdentityUnregister","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityDto"}}}}},"security":[{"API-Key":[]}],"summary":"Toggle Identity Unregistered Management Type","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/bulk":{"patch":{"operationId":"publicBulkUpdateIdentities","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateIdentitiesDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"API-Key":[]}],"summary":"Bulk update multiple identities","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/merge":{"post":{"description":"Merging identities depends on the management type of the identities.
\n For example, a `managed` identity can only be merged into another `managed` identity, while an `external` identity can be merged into a `managed` or `external` identity.
\n The conditions for merging identities are:
\n\n - managed -> managed\n - external -> managed, external\n - system -> managed, external, system\n - unregistered -> managed, external, system\n - unknown -> managed, external, system, unregistered\n ","operationId":"publicMergeIdentities","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergePeopleRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetIdentitiesResponseDto"}}}},"400":{"description":"The requested merge does not follow the allowed patterns."},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Merge identity with another one in batch","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/unmerge":{"post":{"operationId":"publicUnmergeIdentities","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmergeIdentityRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetIdentitiesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Unmerges the identified identity entities","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/{identityId}":{"put":{"description":"Updates an Identity entity.
\n Each field has its own validation rules. Below are some notable behaviors to be aware of:
\n \n managementType — Automatically determined based on the primary email domain and the organization's registered domains. Even if managed is specified, the actual value may be recategorized (e.g. external, system) depending on the email domain.employeeType — Must be compatible with the resolved managementType. If an incompatible type is provided, a default will be assigned.primaryEmail / secondaryEmails — Swapping values between primary and secondary emails will reorder them. If the current primary email is linked to a SaaS account, the old primary must be preserved in secondaryEmails.employeeId — Must be unique within the organization.
\n Note: Additional system-level validations exist beyond those listed above. Refer to the error responses for details.\n ","operationId":"publicUpdateIdentity","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateIdentityDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityDto"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"examples":{"validation_exception":{"summary":"Request rules are not followed.","value":{"statusCode":400,"errorId":"validation_exception","errorDetails":[{"property":"isManager","constraints":{"isEmpty":"isManager must be empty"}}]}},"identity_invalid_employee_type":{"summary":"The employee type is invalid.","value":{"statusCode":400,"errorId":"identity_invalid_employee_type"}},"identity_invalid_employee_status":{"summary":"The employee status is invalid.","value":{"statusCode":400,"errorId":"identity_invalid_employee_status"}},"identity_duplicate_employee_id":{"summary":"The employee id is already in use.","value":{"statusCode":400,"errorId":"identity_duplicate_employee_id"}},"identity_duplicated_email":{"summary":"The email is already in use.","value":{"statusCode":400,"errorId":"identity_duplicated_email"}},"identity_uneditable_email":{"summary":"The email is not editable.","value":{"statusCode":400,"errorId":"identity_uneditable_email"}},"identity_has_devices":{"summary":"The identity has devices.","value":{"statusCode":400,"errorId":"identity_has_devices"}},"identity_has_workspace":{"summary":"The identity has workspaces.","value":{"statusCode":400,"errorId":"identity_has_workspace"}}}}}},"404":{"description":"The identity is not found."},"418":{"description":"The feature isn't available for the organization. Please contact the support team."},"422":{"description":"The custom fields are invalid."}},"security":[{"API-Key":[]}],"summary":"Updates an Identity","tags":["Directory"]},"get":{"operationId":"publicGetIdentity","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}},{"name":"expands","required":false,"in":"query","description":"Expand other datasets when fetching identities. Accepts multiple options.","schema":{"type":"array","items":{"$ref":"#/components/schemas/GetSingleIdentityExpand"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityDto"}}}},"404":{"description":"The identity is not found."},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get an Identity","tags":["Directory"]},"delete":{"operationId":"publicDeleteIdentity","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIdentityDto"}}}},"404":{"description":"The identity is not found."},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Delete an Identity","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/fields/custom":{"get":{"operationId":"getIdentityCustomFields","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetIdentityCustomFieldsListResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get all custom fields of an organization","tags":["Directory"]},"post":{"operationId":"createIdentityCustomField","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateIdentityCustomFieldRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIdentityCustomFieldResponseDto"}}}},"409":{"description":"The custom field unique name is already in use."}},"security":[{"API-Key":[]}],"summary":"Create a custom field for an organization","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/identity/fields/custom/{customFieldId}":{"patch":{"operationId":"updateIdentityCustomField","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"customFieldId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateIdentityCustomFieldRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIdentityCustomFieldResponseDto"}}}},"409":{"description":"The custom field unique name is already in use."}},"security":[{"API-Key":[]}],"summary":"Update a custom field for an organization","tags":["Directory"]},"delete":{"operationId":"deleteIdentityCustomField","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"customFieldId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Delete a custom field for an organization","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/requests":{"post":{"operationId":"publicGetRequest","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"lang","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicGetIggreRequestWithRequestIdDto"},{"$ref":"#/components/schemas/PublicGetIggreRequestWithWorkflowRunIdAndStatusDto"},{"$ref":"#/components/schemas/PublicGetIggreRequestWithPeopleIdAndSuperTypeDto"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetIggreRequestsResponseDto"}}}},"429":{"description":""}},"security":[{"API-Key":[]}],"summary":"Get requests by requestId","tags":["Requests"]}},"/api/v1/organizations/{organizationId}/accounts":{"delete":{"description":"Create aggregation req to deprovision standard accounts and delete custom accounts","operationId":"publicDeleteAccounts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDeleteAccountBulkRequestDto"}}}},"responses":{"200":{"description":"The ID of the created deprovision request, can be used to check the status of the request.
Please use the `/api/v1/organizations/{organizationId}/requests` endpoint to retrieve the status of the deprovisioning request.","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"API-Key":[]}],"summary":"Deactivate or delete accounts","tags":["Accounts"]}},"/api/v1/organizations/{organizationId}/audit-logs/export":{"get":{"description":"Export audit logs csv","operationId":"publicExportAuditLogs","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"startDate","required":true,"in":"query","schema":{"format":"date-time","example":"2022-06","type":"string"}},{"name":"endDate","required":true,"in":"query","schema":{"format":"date-time","example":"2024-01","type":"string"}},{"name":"locale","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}},{"name":"actorType","required":false,"in":"query","schema":{"$ref":"#/components/schemas/AuditLogFilterableActorType"}},{"name":"actorId","required":false,"in":"query","schema":{"example":123,"type":"number"}},{"name":"category","required":false,"in":"query","schema":{"$ref":"#/components/schemas/AuditLogCategory"}}],"responses":{"200":{"description":"To check the status of the export request, use the Get requests by requestId endpoint.","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"API-Key":[]}],"summary":"Export audit logs csv","tags":["AuditLogs"]}},"/api/v1/organizations/{organizationId}/audit-logs/count":{"get":{"description":"Count audit logs","operationId":"publicCountAuditLogs","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"startDate","required":true,"in":"query","schema":{"format":"date-time","example":"2022-06","type":"string"}},{"name":"endDate","required":true,"in":"query","schema":{"format":"date-time","example":"2024-01","type":"string"}},{"name":"locale","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Locale"}},{"name":"actorType","required":false,"in":"query","schema":{"$ref":"#/components/schemas/AuditLogFilterableActorType"}},{"name":"actorId","required":false,"in":"query","schema":{"example":123,"type":"number"}},{"name":"category","required":false,"in":"query","schema":{"$ref":"#/components/schemas/AuditLogCategory"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetAuditLogsCountResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Count audit logs","tags":["AuditLogs"]}},"/api/v1/organizations/{organizationId}/bill-emails":{"get":{"description":"Get all bill emails that belong to an organization. Supports filtering by service name, date range, and pagination.","operationId":"publicGetBillEmails","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"showUnmatchedEmail","required":false,"in":"query","description":"Whether to include emails that are not matched to any service","schema":{"example":true,"type":"boolean"}},{"name":"saasUniqueName","required":false,"in":"query","description":"Filter by service unique name","schema":{"example":"github","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Filter by start date (YYYY-MM-DD format)","schema":{"example":"2022-10-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Filter by end date (YYYY-MM-DD format)","schema":{"example":"2022-10-10","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return","schema":{"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor for pagination","schema":{"example":"xxxxxx","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetBillEmailsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get all bill emails","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/bill-emails/{emailId}/attachments/{fileName}/download-url":{"get":{"description":"Get the S3 signed URL for downloading a specific attachment from a bill email. The URL is valid for a limited time (default: 60 seconds).","operationId":"publicGetBillEmailAttachmentDownloadUrl","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"emailId","required":true,"in":"path","schema":{"type":"string"}},{"name":"fileName","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetAttachmentDownloadUrlResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get download URL for a bill email attachment","tags":["Spends"]}},"/api/v1/organizations/{organizationId}/devices/{deviceId}/meta":{"patch":{"operationId":"publicUpdateDeviceMeta","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateDeviceMetaRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Update device's meta information (assignment info and location)","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/{deviceId}/histories":{"post":{"operationId":"publicCreateDeviceHistory","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateDeviceHistoryEntryDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceHistoryResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Create history entry of a device of an organization","tags":["Devices"]},"delete":{"operationId":"publicDeleteDeviceHistories","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDeleteDeviceHistoriesBulkRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDeleteDeviceHistoryEntriesResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Delete multiple history entries of a device of an organization","tags":["Devices"]},"get":{"operationId":"publicGetDeviceHistories","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceHistoriesListResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get all device's history entries","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/devices/{deviceId}/histories/{historyId}":{"put":{"operationId":"publicUpdateDeviceHistory","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"historyId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateDeviceHistoryEntryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceHistoryResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Update history entry of a device of an organization","tags":["Devices"]},"delete":{"operationId":"publicDeleteDeviceHistory","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"deviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"historyId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetDeviceHistoryResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Delete a single history entry of a device of an organization","tags":["Devices"]}},"/api/v1/organizations/{organizationId}/event-logs":{"get":{"description":"Retrieve event logs for an organization with filtering and pagination support. Event logs track user activities across integrated services.
Pagination: [Cursor-based](#section/Cursor-based)","operationId":"publicGetEventLogs","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":false,"in":"query","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Filter event logs from this start date. Supports both date format (YYYY-MM-DD) and ISO 8601 datetime format (YYYY-MM-DDTHH:mm:ss.sssZ).","schema":{"example":"2022-01-01T00:00:00.000Z","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Filter event logs up to this end date. Supports both date format (YYYY-MM-DD) and ISO 8601 datetime format (YYYY-MM-DDTHH:mm:ss.sssZ).","schema":{"example":"2022-10-27T23:59:59.999Z","type":"string"}},{"name":"searchText","required":false,"in":"query","description":"Search text to filter event logs by user email, service name, or event details.","schema":{"type":"string"}},{"name":"showUnmatched","required":false,"in":"query","description":"Include unmatched event logs (events that couldn't be matched to known users).","schema":{"default":false,"type":"boolean"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return per page.","schema":{"default":50,"example":50,"type":"number"}},{"name":"nextCursor","required":false,"in":"query","description":"Cursor for pagination. Use the nextCursor value from the previous response to fetch the next page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Event logs retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetEventLogsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List event logs","tags":["EventLogs"]}},"/api/v1/organizations/{organizationId}/event-logs/summary/service":{"get":{"description":"List event log summary by service","operationId":"publicGetEventLogSummaryByService","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"date","required":true,"in":"query","description":"Return event logs for the specified month of the year.","schema":{"format":"date","example":"2024-01","type":"string"}},{"name":"excludeUnmatched","required":false,"in":"query","description":"Exclude unmatched event logs.","schema":{"default":false,"type":"boolean"}},{"name":"domainUrl","required":false,"in":"query","description":"Filter by domain URL.","schema":{"type":"string"}},{"name":"skipCache","required":false,"in":"query","description":"Skip cache.","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetEventLogSummaryByServiceResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List event log summary by service","tags":["EventLogs"]}},"/api/v1/organizations/{organizationId}/event-logs/summary/user":{"get":{"description":"List event log summary by user","operationId":"publicGetEventLogSummaryByUser","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit the number of results returned. Maximum 200.","schema":{"maximum":200,"example":50,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor to paginate through results.","schema":{"type":"string"}},{"name":"date","required":true,"in":"query","description":"Return event logs for the specified month of the year.","schema":{"format":"date","example":"2024-01","type":"string"}},{"name":"excludeUnmatched","required":false,"in":"query","description":"Exclude unmatched event logs.","schema":{"default":false,"type":"boolean"}},{"name":"domainUrl","required":false,"in":"query","description":"Filter by domain URL.","schema":{"type":"string"}},{"name":"skipCache","required":false,"in":"query","description":"Skip cache.","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetEventLogSummaryByUserResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"List event log summary by user","tags":["EventLogs"]}},"/api/v1/organizations/{organizationId}/identity/configuration/configuration/{identityId}":{"get":{"operationId":"publicGetSingleIdentityFieldConfiguration","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"identityId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetSingleIdentityFieldConfigurationResponseDto"}}}},"418":{"description":"The feature isn't available for the organization. Please contact the support team."}},"security":[{"API-Key":[]}],"summary":"Get identity field configuration of an identity","tags":["Directory"]}},"/api/v1/organizations/{organizationId}/contracts":{"get":{"operationId":"publicGetContracts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"query","required":false,"in":"query","schema":{"example":"Monthly payment","type":"string"}},{"name":"startDate","required":false,"in":"query","schema":{"format":"date-time","example":"2022-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","schema":{"format":"date-time","example":"2022-03-31","type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"example":"50","type":"number"}},{"name":"cursor","required":false,"in":"query","schema":{"example":"aWQ6MjkzNjE0w","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetContractsResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get all contracts","tags":["Contracts"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/services/{serviceId}/contracts":{"post":{"operationId":"publicCreateContract","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateContractRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicContractResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Create a contract for a service","tags":["Contracts"]}},"/api/v1/organizations/{organizationId}/services/{serviceId}/services/{serviceId}/contracts/{contractId}":{"get":{"operationId":"publicGetContract","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"contractId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicContractResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Get a contract by ID","tags":["Contracts"]},"patch":{"operationId":"publicUpdateContract","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"contractId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateContractRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicContractResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Update a contract by ID","tags":["Contracts"]},"delete":{"operationId":"publicDeleteContract","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":true,"in":"path","schema":{"type":"number"}},{"name":"contractId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicContractResponseDto"}}}}},"security":[{"API-Key":[]}],"summary":"Delete a contract by ID","tags":["Contracts"]}},"/api/v1/organizations/{organizationId}/alerts":{"get":{"description":"Retrieve a paginated list of alerts for the organization. Supports filtering by service, workspace, user, alert type, and alert level.","operationId":"publicGetAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":false,"in":"query","description":"Filter by service ID","schema":{"example":1,"type":"number"}},{"name":"serviceName","required":false,"in":"query","description":"Filter by service name","schema":{"example":"Slack","type":"string"}},{"name":"workspaceId","required":false,"in":"query","description":"Filter by workspace ID","schema":{"example":1,"type":"number"}},{"name":"userIdentifier","required":false,"in":"query","description":"Filter by user identifier. Searches across alert targetId, account key, and primary email. Can accept various formats: peopleAccountId (e.g. '97#user@example.com'), email, or full targetId.","schema":{"example":"user@example.com","type":"string"}},{"name":"type","required":false,"in":"query","description":"Filter by alert type","schema":{"example":"retired_account","type":"string","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"]}},{"name":"level","required":false,"in":"query","description":"Filter by alert level","schema":{"example":"warning","type":"string","enum":["warning","caution"]}},{"name":"muted","required":false,"in":"query","description":"Filter by muted status (true = only muted, false = only unmuted, undefined = all)","schema":{"example":false,"type":"boolean"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page (1-100)","schema":{"default":20,"example":20,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor for pagination. Use the nextCursor value from a previous response to fetch the next page.","schema":{"example":"eyJwYWdlIjoyLCJsaW1pdCI6MjB9","type":"string"}}],"responses":{"200":{"description":"Successfully retrieved alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetAlertsResponseDto"}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Invalid or missing API key"}},"security":[{"API-Key":[]}],"summary":"List organization alerts","tags":["Alerts"]}},"/api/v1/organizations/{organizationId}/alerts/mutes":{"get":{"description":"Retrieve a paginated list of alert type mutes (bulk mutes) for the organization. These are permanent alert suppressions created via the bulk-mute endpoint. Supports filtering by service and alert type.","operationId":"publicGetAlertMutes","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}},{"name":"serviceId","required":false,"in":"query","description":"Filter by service ID","schema":{"example":1,"type":"number"}},{"name":"alertType","required":false,"in":"query","description":"Filter by alert type","schema":{"example":"retired_account","type":"string","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"]}},{"name":"limit","required":false,"in":"query","description":"Number of items per page (1-100)","schema":{"default":20,"example":20,"type":"number"}},{"name":"cursor","required":false,"in":"query","description":"Cursor for pagination. Use the nextCursor value from a previous response to fetch the next page.","schema":{"example":"eyJwYWdlIjoyLCJsaW1pdCI6MjB9","type":"string"}}],"responses":{"200":{"description":"Successfully retrieved alert mutes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicGetAlertMutesResponseDto"}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Invalid or missing API key"}},"security":[{"API-Key":[]}],"summary":"List alert type mutes","tags":["Alerts"]}},"/api/v1/organizations/{organizationId}/alerts/services/mute":{"post":{"description":"Mute all alerts for one or more services, or mute all alerts of a specific type for services. This creates alert type mutes that suppress future alerts matching the criteria.","operationId":"publicBulkMuteAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMuteServiceAlertsRequestDto"}}}},"responses":{"200":{"description":"Successfully muted alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}},"400":{"description":"Invalid request body"},"401":{"description":"Invalid or missing API key"},"404":{"description":"Service not found"}},"security":[{"API-Key":[]}],"summary":"Mute alerts for services","tags":["Alerts"]},"delete":{"description":"Unmute all alerts for one or more services, or unmute all alerts of a specific type for services. This removes alert type mutes that were previously created.","operationId":"publicBulkUnmuteAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUnmuteServiceAlertsRequestDto"}}}},"responses":{"200":{"description":"Successfully unmuted alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}},"400":{"description":"Invalid request body"},"401":{"description":"Invalid or missing API key"},"404":{"description":"Service or alert mute not found"}},"security":[{"API-Key":[]}],"summary":"Unmute alerts for services","tags":["Alerts"]}},"/api/v1/organizations/{organizationId}/alerts/accounts/mute":{"post":{"description":"Mute alerts of a specific type for one or more user accounts. Supports temporary mutes with an optional expiration timestamp.","operationId":"publicMuteAccountAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMuteAccountAlertsRequestDto"}}}},"responses":{"200":{"description":"Successfully muted account alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}},"400":{"description":"Invalid request body"},"401":{"description":"Invalid or missing API key"}},"security":[{"API-Key":[]}],"summary":"Mute alerts for accounts","tags":["Alerts"]},"delete":{"description":"Unmute alerts of a specific type for one or more user accounts. This removes previously set account-level mutes.","operationId":"publicUnmuteAccountAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUnmuteAccountAlertsRequestDto"}}}},"responses":{"200":{"description":"Successfully unmuted account alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}},"400":{"description":"Invalid request body"},"401":{"description":"Invalid or missing API key"}},"security":[{"API-Key":[]}],"summary":"Unmute alerts for accounts","tags":["Alerts"]}},"/api/v1/organizations/{organizationId}/alerts/files/mute":{"post":{"description":"Mute public file alerts for one or more files. Supports temporary mutes with an optional expiration timestamp.","operationId":"publicMuteFileAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMuteFileAlertsRequestDto"}}}},"responses":{"200":{"description":"Successfully muted file alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}},"400":{"description":"Invalid request body"},"401":{"description":"Invalid or missing API key"}},"security":[{"API-Key":[]}],"summary":"Mute public file alerts","tags":["Alerts"]},"delete":{"description":"Unmute public file alerts for one or more files. This removes previously set file-level mutes.","operationId":"publicUnmuteFileAlerts","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUnmuteFileAlertsRequestDto"}}}},"responses":{"200":{"description":"Successfully unmuted file alerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseDto"}}}},"400":{"description":"Invalid request body"},"401":{"description":"Invalid or missing API key"}},"security":[{"API-Key":[]}],"summary":"Unmute public file alerts","tags":["Alerts"]}}},"info":{"title":"Admina Public API","description":"Admina API is a RESTfull API providing programmatic access to much of the data in the system. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate with from a wide variety of environments, from command-line utilities to gadgets to the browser URL bar itself.","version":"1.0","contact":{}},"tags":[{"name":"Organizations","description":""},{"name":"Users","description":""},{"name":"Directory","description":""},{"name":"Departments","description":""},{"name":"Locations","description":""},{"name":"Companies","description":""},{"name":"People","description":""},{"name":"Workspaces","description":""},{"name":"Custom Service and Workspace","description":""},{"name":"Workspace Accounts","description":""},{"name":"Accounts","description":""},{"name":"Contracts","description":""},{"name":"Devices","description":""},{"name":"Devices (alpha)","description":""},{"name":"Alerts","description":""},{"name":"Spends","description":""},{"name":"Usage Optimization","description":""},{"name":"Services","description":""},{"name":"Requests","description":""},{"name":"AuditLogs","description":""},{"name":"EventLogs","description":""}],"servers":[{"url":"https://api.itmc.i.moneyforward.com"}],"components":{"securitySchemes":{"API-Key":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"For authenticated requests, set the `Authorization: Bearer your_api_key` parameter in the header.
You can create and manage your API Keys by visiting the **API Keys** tab in the **Settings** page of your organization in Admina"}},"schemas":{"Location":{"type":"string","enum":["global","us","jp"]},"PublicOrganizationResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Organization Fullname"},"uniqueName":{"type":"string","readOnly":true,"example":"org_unique_name"},"status":{"type":"string","readOnly":true,"example":"active"},"systemLanguage":{"type":"string","readOnly":true,"example":"ja"},"location":{"readOnly":true,"example":"jp","allOf":[{"$ref":"#/components/schemas/Location"}]},"timeZone":{"type":"string","readOnly":true,"example":"Asia/Tokyo"},"domains":{"readOnly":true,"example":["i.moneyforward.com","moneyforward.co.jp"],"type":"array","items":{"type":"string"}},"forwardingEmail":{"type":"string","nullable":true,"readOnly":true,"example":"xxx@forwarding.i.moneyforward.com"},"trialCount":{"type":"number","nullable":false,"readOnly":true,"example":1}},"required":["id","name","uniqueName","status","systemLanguage","location","timeZone","domains","forwardingEmail","trialCount"]},"PeopleType":{"type":"string","enum":["employee","guest","system","unknown"]},"PeopleStatus":{"type":"string","enum":["active","suspended","on_leave"]},"PeopleSortBy":{"type":"string","enum":["type","nameOrAccountKey","accountCount","createdAt"]},"SortOrder":{"type":"string","enum":["DESC","ASC"]},"CursorPaginationMeta":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"readOnly":true,"example":"F3UdkoSbpBNrjwP93AX2HQ"},"totalItems":{"type":"number","nullable":true,"readOnly":true,"example":1}},"required":["nextCursor"]},"PublicCompactPeopleAccountDto":{"type":"object","properties":{"serviceUniqueName":{"type":"string","nullable":true,"readOnly":true,"example":"github"},"serviceName":{"type":"string","nullable":true,"readOnly":true,"example":"GitHub"},"workspaceName":{"type":"string","nullable":true,"readOnly":true,"example":"mfi"},"accountKey":{"type":"string","nullable":true,"readOnly":true,"example":"foo@mfi.com"}},"required":["serviceUniqueName","serviceName","workspaceName","accountKey"]},"PublicPeopleResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"foo@gmail.com"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Yamaha Honda"},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar_url"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"foo"},"type":{"type":"string","readOnly":true,"example":"employee"},"status":{"type":"string","readOnly":true,"example":"suspended"},"suspendedAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-13T19:15:40.000Z"},"createdAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-13T19:15:40.000Z"},"accounts":{"nullable":false,"description":"This attribute will be removed in the near future. Please use [List all SaaS accounts belonging to a person](#tag/People/operation/getPersonAccounts) API to get the list of accounts.","readOnly":true,"deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/PublicCompactPeopleAccountDto"}}},"required":["id","primaryEmail","displayName","avatar","username","type","status","suspendedAt","createdAt","accounts"]},"PublicGetPeopleResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicPeopleResponseDto"}}},"required":["meta","items"]},"MergePeopleDto":{"type":"object","properties":{"fromPeopleId":{"type":"number","example":1},"toPeopleId":{"type":"number","example":2}},"required":["fromPeopleId","toPeopleId"]},"PublicMergePeopleRequestDto":{"type":"object","properties":{"merges":{"type":"array","items":{"$ref":"#/components/schemas/MergePeopleDto"}}},"required":["merges"]},"PublicUnmergePeopleRequestDto":{"type":"object","properties":{"peopleIds":{"example":[1,2,3],"description":"List of people IDs to unmerge.","type":"array","items":{"type":"number"}}},"required":["peopleIds"]},"PeopleAccountRole":{"type":"string","enum":["admin","guest","other"]},"PeopleAccountSortBy":{"type":"string","enum":["service","twoFa","lastActivity"]},"EmployeeStatus":{"type":"string","enum":["active","on_leave","draft","preactive","retired","untracked"]},"EmployeeType":{"type":"string","enum":["board_member","full_time_employee","fixed_time_employee","temporary_employee","part_time_employee","secondment_employee","contract_employee","collaborator","group_address","shared_address","test_address","other","unknown","unregistered"]},"ManagementType":{"type":"string","enum":["managed","external","system","unknown","unregistered"]},"WorkspaceLastExecutionStatus":{"type":"string","enum":["pending","processing","connected","maintenance","suspended","stopped","manual"]},"DeviceAggregationStatus":{"type":"string","enum":["disabled","processing","finished","failed"]},"AuthenAttribute":{"type":"string","enum":["workspaceName","aggreKey","username","email","password","accessToken","refreshToken","secretKey","secretKeyLogin","clientId","clientSecret","region","technicalAccountId","orgId","issuer","privateKey","publicKey","domain","domainCode","baseUri","accountServer","consumerKey","serverId","apiId","customEmailFieldName","basicAuthUser","basicAuthPassword","tokenId","tokenSecret","externalUrl","apiKey","apiSecretKey","otherApiKey","roleArn","externalId","groups","billingTypes","domains","domainList","permissions","integrationTarget","accountOrSubAccountCodes","deviceEnabled","adminPassword","prioritizeBusinessName","userId","deviceGroup","ignoreExternalUserData","applicationKey","formatOfEmployeeId","serialNumberNullValues"]},"ServiceAuthenTypeDto":{"type":"object","properties":{"name":{"type":"string","example":"oauth"},"requiredAttributes":{"type":"array","example":["username","password"],"items":{"$ref":"#/components/schemas/AuthenAttribute"}},"optionalAttributes":{"type":"array","example":["secretKey"],"items":{"$ref":"#/components/schemas/AuthenAttribute"}},"permittedAttributes":{"type":"array","example":["aggreKey"],"items":{"$ref":"#/components/schemas/AuthenAttribute"}},"separatelyUpdatableAttributes":{"type":"array","example":["groups"],"items":{"$ref":"#/components/schemas/AuthenAttribute"}},"variant":{"type":"string","example":"enterprisePlan"},"permissions":{"example":["read-write","read"],"type":"array","items":{"type":"string"}}},"required":["name","requiredAttributes","optionalAttributes","permittedAttributes","separatelyUpdatableAttributes","permissions"]},"ServiceAggreTypeDto":{"type":"object","properties":{"name":{"type":"string","example":"aggregateAll"},"authenTypes":{"type":"array","items":{"$ref":"#/components/schemas/ServiceAuthenTypeDto"}}},"required":["name"]},"CertificationResponseDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Example"},"url":{"type":"string","readOnly":true,"example":"https://example.com"}},"required":["name","url"]},"ServiceMetaResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"vendorName":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor"},"vendorCountryOfOrigin":{"type":"string","nullable":true,"readOnly":true,"example":"Japan"},"termsOfUseUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://example.com"},"privacyPolicyUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://example.com"},"dataSecurityPolicyUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://example.com"},"certifications":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/CertificationResponseDto"}}},"required":["id","vendorName","vendorCountryOfOrigin","termsOfUseUrl","privacyPolicyUrl","dataSecurityPolicyUrl","certifications"]},"ServiceResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Google"},"uniqueName":{"type":"string","readOnly":true,"example":"google"},"url":{"type":"string","readOnly":true,"example":"https://google.com"},"isEmployeeMasterService":{"type":"boolean","readOnly":true,"example":true},"adminUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://admin.google.com/u/0/ac/home"},"userManagementUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://admin.google.com/u/0/ac/users"},"serviceTopUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://workspace.google.com/products/admin/"},"guidanceUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://notion.link/google"},"serviceAlternateUrls":{"nullable":true,"readOnly":true,"example":["www.slides.google.com","www.docs.google.com","www.sheets.google.com"],"type":"array","items":{"type":"string"}},"aggreTypes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ServiceAggreTypeDto"}},"canDeleteAccount":{"type":"boolean","readOnly":true,"example":false},"canDeactivateAccount":{"type":"boolean","readOnly":true,"example":false},"canAggregateSpend":{"type":"boolean","readOnly":true,"example":false},"canAggregateFiles":{"type":"boolean","readOnly":true,"example":false},"canManageFilePermissions":{"type":"boolean","readOnly":true,"example":false},"canOnlyAggregatePublicFiles":{"type":"boolean","readOnly":true,"example":false},"canAggregateDevices":{"type":"boolean","readOnly":true,"example":false},"canPerformMatching":{"type":"boolean","readOnly":true,"example":true},"canProvisionAccount":{"type":"boolean","readOnly":true,"example":false},"isCustomService":{"type":"boolean","readOnly":true,"example":false},"isIdentityProvider":{"type":"boolean","readOnly":true,"example":false},"serviceMeta":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceMetaResponseDto"}]}},"required":["id","name","uniqueName","url","isEmployeeMasterService","adminUrl","userManagementUrl","serviceTopUrl","guidanceUrl","serviceAlternateUrls","aggreTypes","canDeleteAccount","canDeactivateAccount","canAggregateSpend","canAggregateFiles","canManageFilePermissions","canOnlyAggregatePublicFiles","canAggregateDevices","canPerformMatching","canProvisionAccount","isCustomService","isIdentityProvider","serviceMeta"]},"BusinessImpactLevel":{"type":"string","enum":["high","moderate","low"]},"ConfidentialInfo":{"type":"string","enum":["unclassified","confidential","secret","topSecret"]},"SecurityImpactLevel":{"type":"string","enum":["high","moderate","low"]},"WorkspaceMetaResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"workspaceId":{"type":"number","readOnly":true,"example":1},"organizationId":{"type":"number","readOnly":true,"example":1},"note":{"type":"string","nullable":true,"readOnly":true,"example":"Example note"},"businessImpactLevel":{"nullable":true,"readOnly":true,"example":"low","allOf":[{"$ref":"#/components/schemas/BusinessImpactLevel"}]},"dataStoreRegion":{"type":"string","nullable":true,"readOnly":true,"example":"ap-northeast-1"},"piiEnabled":{"type":"boolean","nullable":true,"readOnly":true,"example":false},"pii":{"type":"string","nullable":true,"readOnly":true,"example":"Example note"},"confidentialInfo":{"nullable":true,"readOnly":true,"example":"confidential","allOf":[{"$ref":"#/components/schemas/ConfidentialInfo"}]},"securityImpactLevel":{"nullable":true,"readOnly":true,"example":"low","allOf":[{"$ref":"#/components/schemas/SecurityImpactLevel"}]},"vendorName":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor"},"vendorRelationship":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor Relationship"},"vendorPhone":{"type":"string","nullable":true,"readOnly":true,"example":"12345567890"},"vendorMailAddress":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor Mail address"}},"required":["id","workspaceId","organizationId","note","businessImpactLevel","dataStoreRegion","piiEnabled","pii","confidentialInfo","securityImpactLevel","vendorName","vendorRelationship","vendorPhone","vendorMailAddress"]},"WorkspaceBillingManagerDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Example name"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"Example email"}},"required":["id","avatar","displayName","primaryEmail"]},"WorkspacePeopleInChargeDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Example name"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"Example email"}},"required":["id","avatar","displayName","primaryEmail"]},"UserRoleDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Admin"}},"required":["id","name"]},"UserOrganizationStatus":{"type":"string","enum":["active","invited"]},"OrganizationUserResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"email":{"type":"string","readOnly":true,"example":"foo.bar@example.com"},"name":{"type":"string","readOnly":true,"example":"foo.bar"},"location":{"readOnly":true,"example":"jp","allOf":[{"$ref":"#/components/schemas/Location"}]},"roles":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/UserRoleDto"}},"status":{"readOnly":true,"example":"active","allOf":[{"$ref":"#/components/schemas/UserOrganizationStatus"}]}},"required":["id","email","name","location","roles","status"]},"CustomWorkspaceType":{"type":"string","enum":["google_sheet","manual_import"]},"WorkspaceResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"organizationId":{"type":"number","readOnly":true,"example":1},"serviceId":{"type":"number","readOnly":true,"example":1},"authenType":{"type":"string","nullable":true,"readOnly":true,"example":"api"},"workspaceName":{"type":"string","readOnly":true,"example":"iggre"},"aggreKey":{"type":"string","nullable":true,"readOnly":true,"example":"iggre"},"lastExecutionStatus":{"readOnly":true,"example":"processing","allOf":[{"$ref":"#/components/schemas/WorkspaceLastExecutionStatus"}]},"lastExecutionTime":{"type":"string","nullable":true,"readOnly":true,"example":"2020-11-11 10:00:00"},"lastUsedAt":{"type":"string","nullable":true,"readOnly":true,"example":"2020-11-11 10:00:00"},"lastExecutionResultId":{"type":"string","nullable":true,"readOnly":true,"example":"SUCCESS"},"lastExecutionResultCode":{"type":"number","nullable":true,"readOnly":true,"example":200},"lastExecutionResultMessage":{"type":"string","nullable":true,"readOnly":true,"example":"NOT_FOUND"},"provisioningCredentialEnabled":{"type":"boolean","readOnly":true,"example":false},"description":{"type":"string","nullable":true,"readOnly":true,"example":"Description of the workspace"},"showDescription":{"type":"boolean","readOnly":true,"example":false},"isCustomWorkspace":{"type":"boolean","readOnly":true,"example":false},"deviceAggregationStatus":{"readOnly":true,"example":"finished","allOf":[{"$ref":"#/components/schemas/DeviceAggregationStatus"}]},"service":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceResponseDto"}]},"workspaceMeta":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WorkspaceMetaResponseDto"}]},"billingManagers":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/WorkspaceBillingManagerDto"}},"peopleInCharge":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/WorkspacePeopleInChargeDto"}},"creator":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/OrganizationUserResponseDto"}]},"accountCount":{"type":"number","readOnly":true},"identityProviderWorkspaceId":{"type":"number","nullable":true,"readOnly":true},"customWorkspaceType":{"readOnly":true,"example":"google_sheet","allOf":[{"$ref":"#/components/schemas/CustomWorkspaceType"}]}},"required":["id","organizationId","serviceId","authenType","workspaceName","aggreKey","lastExecutionStatus","lastExecutionTime","lastUsedAt","lastExecutionResultId","lastExecutionResultCode","lastExecutionResultMessage","provisioningCredentialEnabled","description","showDescription","isCustomWorkspace","deviceAggregationStatus","service","workspaceMeta","billingManagers","peopleInCharge","creator","accountCount","identityProviderWorkspaceId","customWorkspaceType"]},"CurrencyTypeIggre":{"type":"string","enum":["jpy","usd","idr"],"description":"Currency of the cost"},"IdentityCost":{"type":"object","properties":{"amount":{"type":"number","example":100,"description":"Cost amount of the employee"},"currency":{"example":"usd","description":"Currency of the cost","allOf":[{"$ref":"#/components/schemas/CurrencyTypeIggre"}]}},"required":["amount","currency"]},"PublicAccountResponseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"123#jessica.jones@addresss.com"},"identityId":{"type":"string","nullable":true,"readOnly":true,"example":"AHF5GF12"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"jessia-jones"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Jessia Jones"},"email":{"type":"string","nullable":true,"readOnly":true,"example":"jessica.jones@address.com"},"roles":{"nullable":true,"readOnly":true,"example":["Member","Admin"],"type":"array","items":{"type":"string"}},"status":{"type":"string","nullable":true,"readOnly":true,"example":"active"},"employeeStatus":{"nullable":true,"readOnly":true,"example":"active","allOf":[{"$ref":"#/components/schemas/EmployeeStatus"}]},"employeeType":{"nullable":true,"readOnly":true,"example":"collaborator","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"employeeManagementType":{"nullable":true,"readOnly":true,"example":"system","allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"twoFa":{"type":"boolean","readOnly":true,"example":true},"uniqueKey":{"type":"string","nullable":true,"readOnly":true,"example":"unique_key"},"lastActivity":{"type":"string","nullable":true,"readOnly":true,"example":"Mon Jan 24 2022 13:20:31 GMT+0900 (Japan Standard Time)"},"isInactive":{"type":"boolean","nullable":true,"readOnly":true,"example":false},"licenses":{"nullable":true,"readOnly":true,"example":["Basic","Basic Plus","Pro","Business"],"type":"array","items":{"type":"string"}},"workspace":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WorkspaceResponseDto"}]},"costs":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityCost"}}},"required":["id","identityId","username","displayName","email","roles","status","employeeStatus","employeeType","employeeManagementType","twoFa","uniqueKey","lastActivity","isInactive","licenses","workspace"]},"PublicGetPeopleAccountsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicAccountResponseDto"}}},"required":["meta","items"]},"UserSortField":{"type":"string","enum":["name","email","role","status"]},"MetaDataDto":{"type":"object","properties":{"prevPage":{"type":"number","nullable":true,"example":1},"nextPage":{"type":"number","nullable":true,"example":3}},"required":["prevPage","nextPage"]},"PublicOrganizationUserResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"email":{"type":"string","readOnly":true,"example":"foo.bar@example.com"},"name":{"type":"string","readOnly":true,"example":"foo.bar"},"location":{"readOnly":true,"example":"jp","allOf":[{"$ref":"#/components/schemas/Location"}]},"roles":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/UserRoleDto"}},"status":{"readOnly":true,"example":"active","allOf":[{"$ref":"#/components/schemas/UserOrganizationStatus"}]}},"required":["id","email","name","location","roles","status"]},"PublicListOrganizationUsersResponseDto":{"type":"object","properties":{"metadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MetaDataDto"}]},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicOrganizationUserResponseDto"}}},"required":["metadata","users"]},"PublicTotalAdminResponseDto":{"type":"object","properties":{"totalAdmins":{"type":"number","readOnly":true,"example":5}},"required":["totalAdmins"]},"PublicUpdateOrganizationUserRequestDto":{"type":"object","properties":{"roleIds":{"example":[2,3],"description":"The list of role ids to assign to the user. Note that admin role cannot be used with other roles, and a user can not have more than 10 roles. This methods performs a full update, so all roles will be replaced with the roles in the request.","type":"array","items":{"type":"number"}}},"required":["roleIds"]},"ServiceSortBy":{"type":"string","enum":["accountCount","serviceName","alertsCount","engagementScore","lastMonthSpending"]},"OrganizationServiceWorkspaceResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"organizationId":{"type":"number","readOnly":true,"example":1},"serviceId":{"type":"number","readOnly":true,"example":1},"workspaceName":{"type":"string","readOnly":true,"example":"iggre"},"lastUsedAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-15T01:54:59.000Z"},"accountsCount":{"type":"number","readOnly":true,"example":30},"isCustomWorkspace":{"type":"boolean","readOnly":true,"example":false}},"required":["id","organizationId","serviceId","workspaceName","lastUsedAt","accountsCount","isCustomWorkspace"]},"SpendingOfMonthDto":{"type":"object","properties":{"amount":{"type":"number","nullable":true,"readOnly":true,"example":10000},"currency":{"type":"string","nullable":true,"readOnly":true,"example":"JPY"}},"required":["amount","currency"]},"PublicOrganizationServiceResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Google"},"uniqueName":{"type":"string","readOnly":true,"example":"google"},"url":{"type":"string","readOnly":true,"example":"https://google.com"},"isEmployeeMasterService":{"type":"boolean","readOnly":true,"example":true},"adminUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://admin.google.com/u/0/ac/home"},"userManagementUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://admin.google.com/u/0/ac/users"},"serviceTopUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://workspace.google.com/products/admin/"},"guidanceUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://notion.link/google"},"serviceAlternateUrls":{"nullable":true,"readOnly":true,"example":["www.slides.google.com","www.docs.google.com","www.sheets.google.com"],"type":"array","items":{"type":"string"}},"workspaces":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/OrganizationServiceWorkspaceResponseDto"}},"warningsCount":{"type":"number","readOnly":true},"cautionsCount":{"type":"number","readOnly":true},"accountsCount":{"type":"number","readOnly":true},"lastMonthSpending":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/SpendingOfMonthDto"}]},"engagementScore":{"type":"number","nullable":true,"readOnly":true},"spendingTrend":{"type":"number","nullable":true,"readOnly":true},"accountsPreview":{"type":"object","readOnly":true,"example":{"people":{"avatar":"xxx"}}},"canDeleteAccount":{"type":"boolean","readOnly":true,"example":false},"canDeactivateAccount":{"type":"boolean","readOnly":true,"example":false},"canAggregateSpend":{"type":"boolean","readOnly":true,"example":false},"canAggregateFiles":{"type":"boolean","readOnly":true,"example":false},"canManageFilePermissions":{"type":"boolean","readOnly":true,"example":false},"canOnlyAggregatePublicFiles":{"type":"boolean","readOnly":true,"example":false},"canAggregateDevices":{"type":"boolean","readOnly":true,"example":false},"canPerformMatching":{"type":"boolean","readOnly":true,"example":true},"canProvisionAccount":{"type":"boolean","readOnly":true,"example":false},"isCustomService":{"type":"boolean","readOnly":true,"example":false}},"required":["id","name","uniqueName","url","isEmployeeMasterService","adminUrl","userManagementUrl","serviceTopUrl","guidanceUrl","serviceAlternateUrls","workspaces","warningsCount","cautionsCount","accountsCount","lastMonthSpending","engagementScore","spendingTrend","accountsPreview","canDeleteAccount","canDeactivateAccount","canAggregateSpend","canAggregateFiles","canManageFilePermissions","canOnlyAggregatePublicFiles","canAggregateDevices","canPerformMatching","canProvisionAccount","isCustomService"]},"CursorPaginationWithCurrencyMeta":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"readOnly":true,"example":"F3UdkoSbpBNrjwP93AX2HQ"},"totalItems":{"type":"number","nullable":true,"readOnly":true,"example":1},"currency":{"type":"string","nullable":true,"readOnly":true,"example":"jpy"}},"required":["nextCursor","currency"]},"PublicGetOrganizationServicesListResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicOrganizationServiceResponseDto"}},"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationWithCurrencyMeta"}]}},"required":["items","meta"]},"PublicServiceEngagementScore":{"type":"object","properties":{"serviceUniqueName":{"type":"string","readOnly":true,"example":"miro"},"serviceName":{"type":"string","readOnly":true,"example":"Miro"},"totalIds":{"type":"number","readOnly":true,"example":30},"engagementScore":{"type":"number","nullable":true,"readOnly":true,"example":8},"payment":{"type":"number","example":230000},"categoryId":{"type":"number","example":1}},"required":["serviceUniqueName","serviceName","totalIds","engagementScore","payment","categoryId"]},"MetaCurrencyDto":{"type":"object","properties":{"currency":{"type":"string","readOnly":true,"example":"jpy"}},"required":["currency"]},"PublicGetEngagementScoresResponseDto":{"type":"object","properties":{"services":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicServiceEngagementScore"}},"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MetaCurrencyDto"}]}},"required":["services","meta"]},"GetUnusedResourcesSortBy":{"type":"string","enum":["retiredAccounts","inactiveAccounts","services"]},"PublicUnusedResourceService":{"type":"object","properties":{"id":{"type":"number","description":"Optional field, not present if the service is unsupported","readOnly":true,"example":123},"serviceName":{"type":"string","readOnly":true,"example":"GitHub"},"serviceUniqueName":{"type":"string","readOnly":true,"example":"github"},"retiredAccounts":{"type":"number","readOnly":true,"example":123},"inactiveAccounts":{"type":"number","readOnly":true,"example":321},"isCustomService":{"type":"boolean","readOnly":true,"example":false},"retiredMuteCount":{"type":"number","readOnly":true,"example":42},"inactiveMuteCount":{"type":"number","readOnly":true,"example":420}},"required":["serviceName","serviceUniqueName","retiredAccounts","inactiveAccounts","isCustomService","retiredMuteCount","inactiveMuteCount"]},"PublicGetUnusedResourcesResponseDto":{"type":"object","properties":{"services":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicUnusedResourceService"}}},"required":["services"]},"AlertType":{"type":"string","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"]},"AlertStatus":{"type":"string","enum":["muted","unmuted"]},"RelatedIdentityDto":{"type":"object","properties":{"id":{"type":"string","description":"ID of the employee"},"displayName":{"type":"string","example":"Display Name","description":"Display name of the employee","nullable":true},"avatar":{"type":"string","description":"URL of the avatar of the employee","nullable":true},"primaryEmail":{"type":"string","example":"primay@email.com","description":"Primary email of the employee","nullable":true}}},"RelatedIdentitiesDto":{"type":"object","properties":{"identityHolder":{"nullable":true,"description":"Identity holder information","type":"object","allOf":[{"$ref":"#/components/schemas/RelatedIdentityDto"}]},"managerHolder":{"nullable":true,"description":"Manager holder information","type":"object","allOf":[{"$ref":"#/components/schemas/RelatedIdentityDto"}]}}},"AccountResponseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"123#jessica.jones@addresss.com"},"identityId":{"type":"string","nullable":true,"readOnly":true,"example":"AHF5GF12"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"jessia-jones"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Jessia Jones"},"email":{"type":"string","nullable":true,"readOnly":true,"example":"jessica.jones@address.com"},"roles":{"nullable":true,"readOnly":true,"example":["Member","Admin"],"type":"array","items":{"type":"string"}},"status":{"type":"string","nullable":true,"readOnly":true,"example":"active"},"employeeStatus":{"nullable":true,"readOnly":true,"example":"active","allOf":[{"$ref":"#/components/schemas/EmployeeStatus"}]},"employeeType":{"nullable":true,"readOnly":true,"example":"collaborator","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"employeeManagementType":{"nullable":true,"readOnly":true,"example":"system","allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"twoFa":{"type":"boolean","readOnly":true,"example":true},"uniqueKey":{"type":"string","nullable":true,"readOnly":true,"example":"unique_key"},"lastActivity":{"type":"string","nullable":true,"readOnly":true,"example":"Mon Jan 24 2022 13:20:31 GMT+0900 (Japan Standard Time)"},"isInactive":{"type":"boolean","nullable":true,"readOnly":true,"example":false},"licenses":{"nullable":true,"readOnly":true,"example":["Basic","Basic Plus","Pro","Business"],"type":"array","items":{"type":"string"}},"workspace":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WorkspaceResponseDto"}]},"costs":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityCost"}},"identity":{"type":"object","nullable":true,"readOnly":true},"alertType":{"type":"array","readOnly":true,"example":["retired_account"],"items":{"$ref":"#/components/schemas/AlertType"}},"memo":{"type":"string","readOnly":true,"example":"This account belongs to Jessica"},"relatedIdentities":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/RelatedIdentitiesDto"}]}},"required":["id","identityId","username","displayName","email","roles","status","employeeStatus","employeeType","employeeManagementType","twoFa","uniqueKey","lastActivity","isInactive","licenses","workspace","identity","memo","relatedIdentities"]},"GetServiceAccountsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/AccountResponseDto"}}},"required":["meta","items"]},"CreateUpdateServiceAccountMemoRequestDto":{"type":"object","properties":{"memo":{"type":"string","example":"This account belongs to Jessica"}},"required":["memo"]},"CreateUpdateServiceAccountMemoResponseDto":{"type":"object","properties":{"organizationId":{"type":"number","readOnly":true,"example":12345678},"serviceId":{"type":"number","readOnly":true,"example":12},"accountId":{"type":"string","example":"123#jessica.jones@addresss.com"},"memo":{"type":"string","example":"This account belongs to Jessica"}},"required":["organizationId","serviceId","accountId","memo"]},"EmptyResponseDto":{"type":"object","properties":{}},"FileSharingStatus":{"type":"string","enum":["public","internal","shared"]},"FileType":{"type":"string","enum":["file","folder"]},"ServiceFilesSortBy":{"type":"string","enum":["fileName","fileType","source","sharingStatus","creationDate","workspaceId","workspaceName"]},"PublicServiceFileResponseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"aggre-file#file-id"},"workspaceId":{"type":"number","readOnly":true,"example":1},"workspaceName":{"type":"string","readOnly":true,"example":"workspace"},"fileName":{"type":"string","readOnly":true,"example":"example.pdf"},"filePath":{"type":"string","nullable":true,"readOnly":true,"example":"/foo/bar/baz"},"fileType":{"type":"string","readOnly":true,"example":"pdf"},"fileUrl":{"type":"string","readOnly":true,"example":"https://drive.google.com/file/d/..."},"source":{"type":"string","readOnly":true,"example":"Google Drive"},"sharingStatus":{"type":"string","readOnly":true,"example":"public"},"creationDate":{"type":"string","readOnly":true,"example":"2022-10-19T14:42:24.931Z"},"owners":{"readOnly":true,"example":["email1@iggre.net","email2@iggre.net"],"type":"array","items":{"type":"string"}},"ownerCount":{"type":"number","readOnly":true,"example":123},"markedAsSafe":{"type":"boolean","readOnly":true,"example":false}},"required":["id","workspaceId","workspaceName","fileName","filePath","fileType","fileUrl","source","sharingStatus","creationDate","owners","ownerCount","markedAsSafe"]},"PublicGetServiceFilesResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicServiceFileResponseDto"}}},"required":["meta","items"]},"PublicGetServiceFilesSummaryResponseDto":{"type":"object","properties":{"total":{"type":"number","readOnly":true},"public":{"type":"number","readOnly":true},"sharedExternally":{"type":"number","readOnly":true}},"required":["total","public","sharedExternally"]},"SafeListStatus":{"type":"string","enum":["not_applied","applied","applying"]},"ServiceFileSafeListDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"asdfgh12345"},"name":{"type":"string","readOnly":true,"example":"Awesome list"},"remarks":{"type":"string","readOnly":true,"example":"Awesome list description"},"workspaceId":{"type":"number","readOnly":true,"example":123},"files":{"type":"number","readOnly":true,"example":123},"emails":{"type":"number","readOnly":true,"example":123},"groups":{"type":"number","readOnly":true,"example":123},"domains":{"type":"number","readOnly":true,"example":123},"status":{"readOnly":true,"example":"applied","allOf":[{"$ref":"#/components/schemas/SafeListStatus"}]},"allFiles":{"type":"boolean","readOnly":true,"example":false},"highConfidence":{"type":"boolean","readOnly":true,"example":false}},"required":["id","name","remarks","workspaceId","files","emails","groups","domains","status","allFiles","highConfidence"]},"PublicGetServiceFileSafeListsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ServiceFileSafeListDto"}}},"required":["meta","items"]},"WorkspaceMetaQueryDto":{"type":"object","properties":{"businessImpactLevel":{"example":"low","description":"Filter workspaces by business impact level.","allOf":[{"$ref":"#/components/schemas/BusinessImpactLevel"}]},"piiEnabled":{"type":"boolean","description":"Filter workspaces by PII enabled status."},"confidentialInfo":{"example":"confidential","description":"Filter workspaces by confidential info level.","allOf":[{"$ref":"#/components/schemas/ConfidentialInfo"}]},"securityImpactLevel":{"example":"low","description":"Filter workspaces by security impact level.","allOf":[{"$ref":"#/components/schemas/SecurityImpactLevel"}]}}},"PublicServiceResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Google"},"uniqueName":{"type":"string","readOnly":true,"example":"google"},"url":{"type":"string","readOnly":true,"example":"https://google.com"},"adminUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://admin.google.com/u/0/ac/home"},"userManagementUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://admin.google.com/u/0/ac/users"},"serviceTopUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://workspace.google.com/products/admin/"},"serviceAlternateUrls":{"nullable":true,"readOnly":true,"example":["www.slides.google.com","www.docs.google.com","www.sheets.google.com"],"type":"array","items":{"type":"string"}},"canDeleteAccount":{"type":"boolean","readOnly":true,"example":true},"canDeactivateAccount":{"type":"boolean","readOnly":true,"example":true}},"required":["id","name","uniqueName","url","adminUrl","userManagementUrl","serviceTopUrl","serviceAlternateUrls","canDeleteAccount","canDeactivateAccount"]},"PublicWorkspaceMetaResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"workspaceId":{"type":"number","readOnly":true,"example":1},"organizationId":{"type":"number","readOnly":true,"example":1},"note":{"type":"string","nullable":true,"readOnly":true,"example":"Example note"},"businessImpactLevel":{"nullable":true,"readOnly":true,"example":"low","allOf":[{"$ref":"#/components/schemas/BusinessImpactLevel"}]},"dataStoreRegion":{"type":"string","nullable":true,"readOnly":true,"example":"ap-northeast-1"},"piiEnabled":{"type":"boolean","nullable":true,"readOnly":true,"example":false},"pii":{"type":"string","nullable":true,"readOnly":true,"example":"Example note"},"confidentialInfo":{"nullable":true,"readOnly":true,"example":"confidential","allOf":[{"$ref":"#/components/schemas/ConfidentialInfo"}]},"securityImpactLevel":{"nullable":true,"readOnly":true,"example":"low","allOf":[{"$ref":"#/components/schemas/SecurityImpactLevel"}]},"vendorName":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor"},"vendorRelationship":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor Relationship"},"vendorPhone":{"type":"string","nullable":true,"readOnly":true,"example":"12345567890"},"vendorMailAddress":{"type":"string","nullable":true,"readOnly":true,"example":"Example Vendor Mail address"}},"required":["id","workspaceId","organizationId","note","businessImpactLevel","dataStoreRegion","piiEnabled","pii","confidentialInfo","securityImpactLevel","vendorName","vendorRelationship","vendorPhone","vendorMailAddress"]},"PublicWorkspaceBillingManagerDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Example name"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"Example email"}},"required":["id","avatar","displayName","primaryEmail"]},"PublicWorkspacePeopleInChargeDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Example name"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"Example email"}},"required":["id","avatar","displayName","primaryEmail"]},"PublicWorkspaceResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"organizationId":{"type":"number","readOnly":true,"example":1},"workspaceName":{"type":"string","readOnly":true,"example":"iggre"},"lastUsedAt":{"type":"string","nullable":true,"readOnly":true,"example":"2020-11-11 10:00:00"},"service":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PublicServiceResponseDto"}]},"creator":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PublicOrganizationUserResponseDto"}]},"isCustomWorkspace":{"type":"boolean","readOnly":true,"example":false},"identityProviderWorkspaceId":{"type":"number","nullable":true,"readOnly":true},"workspaceMeta":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PublicWorkspaceMetaResponseDto"}]},"billingManagers":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicWorkspaceBillingManagerDto"}},"peopleInCharge":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicWorkspacePeopleInChargeDto"}},"lastExecutionTime":{"type":"string","nullable":true,"readOnly":true,"example":"2020-11-11 10:00:00"},"lastExecutionStatus":{"type":"string","readOnly":true,"enum":["pending","processing","connected","maintenance","suspended","stopped","manual"],"example":"processing"},"lastExecutionResultId":{"type":"string","nullable":true,"readOnly":true,"enum":["0","1","100","101","103","200","201","202","203","204","205","206","207","208","209","210","211","212","213","214","215","216","217","218","219","220","221","222","223","224","225","226","227","228","229","230","250","300","301","302","303","304","305","306","307","308","309","310","311","312","313","314","315","316","320","350","351","352","353","998","999","SUCCESS","PARTIAL_SUCCESS","REQUIRE_ADDITIONAL_INPUT","REQUIRE_POLICY_CONFIRMATION","REQUIRE_VERIFY_EMAIL","NOT_FOUND","WORKSPACE_NOT_FOUND","NOT_ENOUGH_ACCESS_TOKEN_PERMISSION","INCORRECT_CREDENTIALS","WRONG_PLAN","REFRESH_TOKEN_EXPIRED","TRIAL_ACCOUNT_EXPIRED","ACCOUNT_TYPE_NOT_SUPPORT","USER_NOT_FOUND_IN_DATABASE","USER_CANNOT_BE_DELETED","USER_IS_LAST_ADMIN","USER_CANNOT_BE_DEACTIVATED","USER_HAS_BEEN_DEACTIVATED","USER_DEPROVISIONING_REQUEST_NOT_EXISTS","REQUIRE_OTP_SETUP_FINISHED","TWO_FA_METHOD_NOT_ENABLED","DOMAIN_IS_NOT_VALID","NOT_SUPPORT_SAML_SSO_ONLY","NOT_SUPPORT_LOGIN_WITH_2FA","ACCOUNT_IS_NOT_ACTIVE","USER_ALREADY_EXISTS","SET_GROUPS_ACTION_REQUIRED","TEAM_NOT_FOUND","LICENSE_LIMIT_EXCEED","INVALID_PROVISIONING_INPUT","USER_CANNOT_BE_ASSIGNED_TO_WORKSPACE","USER_LIMIT_EXCEED","CANNOT_TRANSFER_DATA","IP_RESTRICTED","INSUFFICIENT_PASSWORD_COMPLEXITY","USER_ACCOUNT_LOCKED","FILE_AGGRE_ABORTED","SYSTEM_ERROR","API_RATE_LIMIT","INVALID_SCRAPING_DATA_FORMAT","TIMEOUT_ERROR","AGGRE_TARGET_SYSTEM_MAINTENANCE","WRONG_METHOD","AGGRE_TARGET_SYSTEM_ERROR","AGGRE_TARGET_COOKIE_ERROR","AGGRE_TARGET_INSTANCE_HIBERNATED","AGGRE_TARGET_API_VERSION","AGGRE_TARGET_LOCAL_STORAGE_ERROR","AGGRE_TARGET_TOKEN_ERROR","BYPASS_BOT_DETECTED","AGGRE_TARGET_USER_NOT_FOUND","AGGRE_TARGET_USER_ALREADY_DELETED","AGGRE_TARGET_ACTIVE_SESSION_LIMIT_REACHED","RETRYABLE_SYSTEM_ERROR","AGGRE_PROCESSOR_ERROR","IMPORT_CSV_NOT_FOUND","CSV_VALIDATION_ERRORS","UNKNOWN_ENCODING","EMPTY_CSV_FILE","OUT_OF_MEMORY_ERROR","UNKNOWN_ERROR"],"example":0},"lastExecutionResultMessage":{"type":"string","nullable":true,"readOnly":true,"example":"NOT_FOUND"}},"required":["id","organizationId","workspaceName","lastUsedAt","service","creator","isCustomWorkspace","identityProviderWorkspaceId","workspaceMeta","billingManagers","peopleInCharge","lastExecutionTime","lastExecutionStatus","lastExecutionResultId","lastExecutionResultMessage"]},"PublicCustomWorkspaceWithAdminaServiceDto":{"type":"object","properties":{"serviceId":{"type":"number","example":1,"description":"Standard service ID or custom service ID belonging to organization"},"workspaceName":{"type":"string","example":"admina","description":"Name to give to the workspace"},"customWorkspaceType":{"example":"google_sheet","allOf":[{"$ref":"#/components/schemas/CustomWorkspaceType"}]}},"required":["serviceId","workspaceName","customWorkspaceType"]},"PublicCustomWorkspaceWithServiceMasterDto":{"type":"object","properties":{"serviceMasterName":{"type":"string","example":"zoom","description":"Master service name which enables matching for activity logs, spending data and such"},"workspaceName":{"type":"string","example":"admina","description":"Name to give to the workspace"},"customWorkspaceType":{"example":"google_sheet","allOf":[{"$ref":"#/components/schemas/CustomWorkspaceType"}]}},"required":["serviceMasterName","workspaceName","customWorkspaceType"]},"PublicCustomWorkspaceWithCustomServiceDto":{"type":"object","properties":{"serviceName":{"type":"string","example":"Admina","description":"Name to give to the custom service"},"serviceUrl":{"type":"string","example":"https://example.com","description":"URL to attach to the custom service"},"workspaceName":{"type":"string","example":"admina","description":"Name to give to the workspace"},"customWorkspaceType":{"example":"manual_import","allOf":[{"$ref":"#/components/schemas/CustomWorkspaceType"}]}},"required":["serviceName","workspaceName","customWorkspaceType"]},"PublicCreateCustomWorkspaceResponseDto":{"type":"object","properties":{"service":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ServiceResponseDto"}]},"workspace":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/WorkspaceResponseDto"}]},"isNewService":{"type":"boolean","readOnly":true}},"required":["service","workspace","isNewService"]},"Locale":{"type":"string","enum":["en","ja"]},"ProvisioningSectionDataType":{"type":"string","enum":["text","url","password","email","list of options","option"],"description":"Type of data expected for the field"},"RegexConstraint":{"type":"object","properties":{"value":{"type":"string","readOnly":true,"example":"^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[#?!@$%^&*-]).{8,}$"},"message":{"type":"string","readOnly":true,"example":"provisioning.default_password_regex_message"}},"required":["value","message"]},"ProvisioningSectionFieldConstraint":{"type":"object","properties":{"required":{"type":"boolean","readOnly":true,"example":true},"minLength":{"type":"number","readOnly":true,"example":1},"maxLength":{"type":"number","readOnly":true,"example":64},"regex":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/RegexConstraint"}]}},"required":["required","minLength","maxLength","regex"]},"Option":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"ab144hnx3e99h"},"label":{"type":"string","readOnly":true,"example":"Administrator License"}}},"ProvisioningType":{"type":"string","enum":["invite","create"],"description":"Do not set this field for the following provisioning types"},"PublicProvisioningField":{"type":"object","properties":{"key":{"type":"string","description":"Key to be used in the request body to set the value for this field","readOnly":true,"example":"setLicenses"},"description":{"type":"string","description":"Describes the data that is expected for each field","readOnly":true,"example":"licenses"},"type":{"description":"Type of data expected for the field","readOnly":true,"example":"list of options","allOf":[{"$ref":"#/components/schemas/ProvisioningSectionDataType"}]},"constraints":{"description":"Constraints for the field","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ProvisioningSectionFieldConstraint"}]},"options":{"description":"List of options to choose from","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Option"}},"multiple":{"type":"boolean","description":"Can choose multiple options","readOnly":true,"example":true},"hideForProvisioningType":{"description":"Do not set this field for the following provisioning types","readOnly":true,"example":"invite","allOf":[{"$ref":"#/components/schemas/ProvisioningType"}]}},"required":["key","description","type","constraints","options","multiple","hideForProvisioningType"]},"PublicGetProvisioningMetaResponseDto":{"type":"object","properties":{"fields":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicProvisioningField"}}},"required":["fields"]},"WorkspaceFilePermissionType":{"type":"string","enum":["user","group","link","public_responses"]},"WorkspaceFilePermissionScope":{"type":"string","enum":["internal","external"]},"WorkspaceFileAuthorizedAccount":{"type":"object","properties":{"email":{"type":"string","readOnly":true,"example":"foo@example.com"},"status":{"readOnly":true,"example":"on_leave","allOf":[{"$ref":"#/components/schemas/PeopleStatus"}]},"type":{"readOnly":true,"example":"unknown","allOf":[{"$ref":"#/components/schemas/PeopleType"}]},"name":{"type":"string","nullable":true,"readOnly":true,"example":"Foo Bar Baz"}},"required":["email","status","type"]},"WorkspaceFilePermissionResponseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1gr23u79r"},"type":{"readOnly":true,"example":"group","allOf":[{"$ref":"#/components/schemas/WorkspaceFilePermissionType"}]},"scope":{"readOnly":true,"example":"external","allOf":[{"$ref":"#/components/schemas/WorkspaceFilePermissionScope"}]},"isOwner":{"type":"boolean","readOnly":true,"example":false},"canChangePermission":{"type":"boolean","readOnly":true,"example":true},"accounts":{"readOnly":true,"example":["foo@example.com","bar@example.com"],"type":"array","items":{"$ref":"#/components/schemas/WorkspaceFileAuthorizedAccount"}},"name":{"type":"string","readOnly":true,"example":"foo"},"sharingLink":{"type":"string","readOnly":true,"example":"foo"},"safeListIdentifier":{"type":"string","readOnly":true,"example":"foo"},"isMarkedSafe":{"type":"boolean","readOnly":true,"example":false}},"required":["id","type","scope","isOwner","canChangePermission","accounts","isMarkedSafe"]},"GetWorkspaceFilePermissionsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/WorkspaceFilePermissionResponseDto"}}},"required":["meta","items"]},"PublicListServicesResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicServiceResponseDto"}}},"required":["meta","items"]},"PublicSpendEntry":{"type":"object","properties":{"date":{"type":"string","readOnly":true,"format":"date","example":"2021-11-01"},"amount":{"type":"number","readOnly":true,"example":1231231}},"required":["date","amount"]},"PublicSpendsByService":{"type":"object","properties":{"serviceName":{"type":"string","readOnly":true,"example":"Github"},"serviceUniqueName":{"type":"string","readOnly":true,"example":"github"},"spends":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicSpendEntry"}}},"required":["serviceName","serviceUniqueName","spends"]},"PublicGetSpendsByServicesResponseDto":{"type":"object","properties":{"services":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicSpendsByService"}},"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MetaCurrencyDto"}]}},"required":["services","meta"]},"IntersectionMetaCurrencyDtoMetaDateRangeDto":{"type":"object","properties":{"currency":{"type":"string","readOnly":true,"example":"jpy"},"startDate":{"format":"YYYY-MM-DD","type":"string","readOnly":true,"example":"2021-11-01"},"endDate":{"format":"YYYY-MM-DD","type":"string","readOnly":true,"example":"2022-01-31"}},"required":["currency","startDate","endDate"]},"PublicGetMonthlySpendsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/IntersectionMetaCurrencyDtoMetaDateRangeDto"}]},"spends":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicSpendEntry"}}},"required":["meta","spends"]},"CurrencyType":{"type":"string","enum":["jpy","usd","idr"]},"SimpleSpendDto":{"type":"object","properties":{"date":{"type":"string","example":"2024-10-23","format":"date"},"amount":{"type":"number","example":1000},"currency":{"example":"usd","allOf":[{"$ref":"#/components/schemas/CurrencyType"}]},"serviceName":{"type":"string","example":"Dropbox"},"description":{"type":"string","example":"Dropbox yearly subscription"}},"required":["date","amount","currency"]},"ImportSpendsRequestDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SimpleSpendDto"}}},"required":["data"]},"IggreRequestResponseDto":{"type":"object","properties":{"requestId":{"type":"string","readOnly":true,"example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["requestId"]},"PublicCreateCustomAccountRequestDto":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"test@example.com","description":"The email of the account."},"displayName":{"type":"string","description":"The display name of the account."},"userName":{"type":"string","description":"The user name of the account."},"roles":{"description":"The roles of the account. Accepts a list of role names.","type":"array","items":{"type":"string"}},"licenses":{"description":"The licenses of the account. Accepts a list of license names.","type":"array","items":{"type":"string"}},"twoFa":{"type":"boolean","description":"The two factor authentication status of the account."}},"required":["email"]},"PublicCreateCustomAccountBulkRequestDto":{"type":"object","properties":{"create":{"type":"array","items":{"$ref":"#/components/schemas/PublicCreateCustomAccountRequestDto"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PublicCreateCustomAccountRequestDto"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PublicCreateCustomAccountRequestDto"}}},"required":["create","update","delete"]},"PublicCreateAccountRequestDto":{"type":"object","properties":{"data":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"example":{"provisioningType":"invite","licenses":["license1","license2"]},"description":"\nTo create an account for a workspace, following are the steps:\n\n- **Step 1**: `GET /workspaces/:workspaceId/provisioning-meta` This returns a list of fields.\n- **Step 2**: `POST /workspaces/:workspaceId/accounts` Make a request based on the meta response from the previous step.\n- **Step 3**: `GET /requests/:requestId` Use requestId from previous step to check status\n\nContinue polling this API until status changes to “finished” or “failed”. There will be a rate limit on this API, so please use an interval of 1s.\n "},"workflowRunId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"The ID of the workflow run."}},"required":["data"]},"GetCreateAccountResponseDto":{"type":"object","properties":{"requestId":{"type":"string","readOnly":true,"example":"1"}},"required":["requestId"]},"ValidationErrorResponseDto":{"type":"object","properties":{"field":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["field","message"]},"ValidationErrorListResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorResponseDto"}}},"required":["items"]},"SafeListEntityDto":{"type":"object","properties":{"name":{"type":"string","example":"foo bar baz"},"id":{"type":"string","example":"asdfgh12345"}},"required":["name","id"]},"SafeListRequestDto":{"type":"object","properties":{"safeDomains":{"example":["foo.com","bar.com"],"type":"array","items":{"type":"string"}},"safeEmailIds":{"example":["foo@example.com"],"type":"array","items":{"type":"string"}},"safeFiles":{"example":[{"name":"foo","id":"asdfgh12345"}],"type":"array","items":{"$ref":"#/components/schemas/SafeListEntityDto"}},"safeGroups":{"example":[{"name":"foo","id":"asdfgh12345"}],"type":"array","items":{"$ref":"#/components/schemas/SafeListEntityDto"}}}},"PublicCreateWorkspaceFileSafeListRequestDto":{"type":"object","properties":{"remarks":{"type":"string","example":"foo bar baz description"},"allFiles":{"type":"boolean","example":true},"highConfidence":{"type":"boolean","example":true},"create":{"$ref":"#/components/schemas/SafeListRequestDto"},"name":{"type":"string","example":"foo bar baz"}},"required":["name"]},"PublicBulkUpdateWorkspaceFileSafeListRequestDto":{"type":"object","properties":{"safeListIds":{"example":["asdfgh12345"],"type":"array","items":{"type":"string"}},"create":{"$ref":"#/components/schemas/SafeListRequestDto"}},"required":["safeListIds","create"]},"PublicUpdateWorkspaceFileSafeListRequestDto":{"type":"object","properties":{"name":{"type":"string","example":"foo bar baz"},"remarks":{"type":"string","example":"foo bar baz description"},"allFiles":{"type":"boolean","example":true},"highConfidence":{"type":"boolean","example":true},"create":{"$ref":"#/components/schemas/SafeListRequestDto"},"delete":{"$ref":"#/components/schemas/SafeListRequestDto"}}},"PublicGetSafeListResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/SafeListEntityDto"}}},"required":["meta","items"]},"UsageBasedResourceType":{"type":"string","enum":["datadog-infrastructure-host"]},"PublicUnutilizedResourceResponseDto":{"type":"object","properties":{"organizationId":{"type":"number","readOnly":true,"example":1},"serviceUniqueName":{"type":"string","readOnly":true,"example":"datadog"},"workspaceId":{"type":"number","readOnly":true,"example":12345678},"resourceType":{"type":"string","readOnly":true,"example":"datadog-infrastructure-host"},"resourceId":{"type":"string","readOnly":true,"example":"id-12345678"},"resourceAttributes":{"type":"string","readOnly":true,"example":"abc123"}},"required":["organizationId","serviceUniqueName","workspaceId","resourceType","resourceId","resourceAttributes"]},"PublicGetUnutilizedResourcesResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicUnutilizedResourceResponseDto"}},"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]}},"required":["items","meta"]},"DeviceType":{"type":"string","enum":["pc","phone","other"]},"PublicPeopleResponseDtoWithoutAccounts":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"foo@gmail.com"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Yamaha Honda"},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar_url"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"foo"},"type":{"type":"string","readOnly":true,"example":"employee"},"status":{"type":"string","readOnly":true,"example":"suspended"},"suspendedAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-13T19:15:40.000Z"},"createdAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-13T19:15:40.000Z"}},"required":["id","primaryEmail","displayName","avatar","username","type","status","suspendedAt","createdAt"]},"ExtendedEmployeeStatus":{"type":"string","enum":["active","on_leave","draft","preactive","retired","untracked","archived"],"description":"Extended status of the employee"},"DepartmentDtoElement":{"type":"object","properties":{"name":{"type":"string","example":"department name","description":"Department name of the employee","nullable":true}}},"PublicSimpleIdentityDto":{"type":"object","properties":{"id":{"type":"string","description":"ID of the employee"},"organizationId":{"type":"number","description":"ID of the organization"},"peopleId":{"type":"string","description":"ID of the people"},"employeeStatus":{"example":"active","description":"Extended status of the employee","allOf":[{"$ref":"#/components/schemas/ExtendedEmployeeStatus"}]},"employeeType":{"example":"full_time_employee","description":"Type of the employee","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"managementType":{"example":"managed","description":"Management type of the employee","nullable":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"displayName":{"type":"string","example":"Display Name","description":"Display name of the employee","nullable":true},"firstName":{"type":"string","example":"First Name","description":"First name of the employee","nullable":true},"lastName":{"type":"string","example":"Last Name","description":"Last name of the employee","nullable":true},"avatar":{"type":"string","description":"URL of the avatar of the employee","nullable":true},"primaryEmail":{"type":"string","example":"primay@email.com","description":"Primary email of the employee","nullable":true},"secondaryEmails":{"example":["secondary+1@email.com","secondary+2@email.com"],"description":"Secondary emails of the employee","nullable":true,"type":"array","items":{"type":"string"}},"companyName":{"type":"string","example":"company name","description":"Company name of the employee","nullable":true},"workLocation":{"type":"string","example":"work location","description":"Work location of the employee","nullable":true},"department":{"description":"Department of the employee","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepartmentDtoElement"}]},"serviceCount":{"type":"number","description":"Number of services the employee has","nullable":true},"deviceCount":{"type":"number","description":"Number of devices the employee has","nullable":true},"costs":{"description":"Costs of the employee","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityCost"}},"createdAt":{"format":"date-time","type":"string","description":"Record created at","nullable":true},"updatedAt":{"format":"date-time","type":"string","description":"Record updated at","nullable":true},"isManager":{"type":"boolean","description":"Is the employee a manager","nullable":true},"isMock":{"type":"boolean","description":"Indicates if the identity is a mock"},"isEmailEditable":{"type":"boolean","description":"Indicates if the email of the identity is editable","nullable":true},"hasPresetFieldsUnlinked":{"type":"boolean","description":"Indicates if the unlink preset fields is enabled","nullable":true}},"required":["employeeStatus","employeeType","firstName","lastName"]},"CustomFieldWithMetadataDto":{"type":"object","properties":{"id":{"type":"number","description":"The ID of the custom field template","example":1},"attributeCode":{"type":"string","description":"The unique identifier for the custom field","example":"custom_uuid"},"attributeName":{"type":"string","description":"The display label for the custom field","example":"custom_text_field"},"value":{"type":"object","description":"The value of the custom field (string, number, or date string depending on the field type)","example":"foo"}},"required":["id","attributeCode","attributeName","value"]},"PublicDeviceDto":{"type":"object","properties":{"id":{"type":"number","example":123,"description":"Unique identifier for the device"},"memo":{"type":"string","example":"foo bar","description":"Additional notes or memo about the device"},"type":{"type":"string","enum":["pc","phone","other"],"example":"pc","description":"Type of the device (e.g., PC, Phone, Tablet)"},"people":{"nullable":true,"description":"Person assigned to this device, or null if unassigned","type":"object","allOf":[{"$ref":"#/components/schemas/PublicPeopleResponseDtoWithoutAccounts"}]},"identity":{"nullable":true,"description":"Identity information of the assigned person, or null if unassigned","type":"object","allOf":[{"$ref":"#/components/schemas/PublicSimpleIdentityDto"}]},"preset":{"type":"object","example":{"subtype":"other","price":123.321},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Preset fields for the device. This is a hashmap where the key maps to the field `uniqueName` in device fields."},"custom":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Custom fields for the device. This is a hashmap where the key maps to the field `uniqueName` in device fields."},"createdAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00Z","description":"Timestamp when the device was created"},"updatedAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00Z","description":"Timestamp when the device was last updated"},"customFieldsWithMetadata":{"readOnly":true,"example":[{"id":1,"attributeCode":"custom_text_field","attributeName":"Text field","value":"foo"},{"id":2,"attributeCode":"custom_date_field","attributeName":"Date field","value":"2024-01-01"},{"id":3,"attributeCode":"custom_number_field","attributeName":"Number field","value":123},{"id":4,"attributeCode":"custom_dropdown_field","attributeName":"Dropdown field","value":"Option Displayed Value A"}],"type":"array","items":{"$ref":"#/components/schemas/CustomFieldWithMetadataDto"}}},"required":["id","memo","type","people","identity","preset","custom","createdAt","updatedAt","customFieldsWithMetadata"]},"PublicGetDevicesListResponseDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata including cursor for next page","allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"description":"List of devices matching the query criteria","type":"array","items":{"$ref":"#/components/schemas/PublicDeviceDto"}}},"required":["meta","items"]},"PublicDeviceFieldDropdownConfigurationDto":{"type":"object","properties":{"label":{"type":"string","readOnly":true,"example":"Foo"}},"required":["label"]},"PublicDeviceFieldDtoV1Alpha":{"type":"object","properties":{"id":{"type":"number","nullable":true,"readOnly":true,"example":123},"uniqueName":{"type":"string","readOnly":true,"example":"foo"},"source":{"type":"string","readOnly":true,"enum":["preset","custom"],"example":"preset"},"kind":{"type":"string","readOnly":true,"enum":["text","date","number","dropdown"],"example":"text"},"name":{"type":"string","readOnly":true,"example":"Foo"},"required":{"type":"boolean","readOnly":true,"example":true},"visibleForType":{"type":"array","example":["other","phone"],"items":{"type":"string","enum":["pc","phone","other"]}},"hidden":{"type":"boolean","readOnly":true,"example":true},"configuration":{"type":"object","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicDeviceFieldDropdownConfigurationDto"}}],"nullable":true}},"required":["id","uniqueName","source","kind","name","required","visibleForType","hidden","configuration"]},"PublicGetDeviceFieldsListResponseDtoV1Alpha":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicDeviceFieldDtoV1Alpha"}}},"required":["items"]},"DeviceFilterOptions":{"type":"object","properties":{"minDate":{"type":"string","example":"2021-01-01","format":"date","description":"only supported by fields with `date` kind"},"maxDate":{"type":"string","example":"2021-01-01","format":"date","description":"only supported by fields with `date` kind"},"minNumber":{"type":"number","example":1,"description":"only supported by fields with `number` kind and few special fields such as `$age`"},"maxNumber":{"type":"number","example":2,"description":"only supported by fields with `number` kind and few special fields such as `$age`"},"eq":{"type":"string","example":"foo","description":"only supported by fields with `dropdown` kind"}}},"PublicSearchDevicesRequestDto":{"type":"object","properties":{"peopleId":{"type":"number","example":5034567,"description":"Filter devices by the people ID assigned to them"},"type":{"example":"pc","description":"Filter devices by device type","allOf":[{"$ref":"#/components/schemas/DeviceType"}]},"groupId":{"type":"number","example":42,"description":"Filter devices to those matching the conditions of the given Device Group (restricts results to the group's member devices)."},"employeeStatus":{"example":"active","description":"Filter devices by the employment status of the assigned person","allOf":[{"$ref":"#/components/schemas/EmployeeStatus"}]},"searchTerm":{"type":"string","example":"foo","description":"Search term to filter devices. Searches across fields specified in searchFields"},"searchFields":{"example":["memo","people.primaryEmail","people.displayName","preset.asset_number","preset.","custom."],"description":"Array of field names to search within when using searchTerm. Supports memo, people fields, preset fields, and custom fields","type":"array","items":{"type":"string"}},"filters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceFilterOptions"},"description":"The object key is the field name, and the value is the filter options. Keys look like `preset.`. There are certain extra virtual fields, such as `$age`, please check implementation or ask a backend engineer."}}},"DeviceExpand":{"type":"string","enum":["relatedIdentity","customFieldsMetadata"]},"CompactPeopleAccountDto":{"type":"object","properties":{"id":{"type":"string","nullable":true,"readOnly":true,"example":"1#foo"},"serviceId":{"type":"number","nullable":true,"readOnly":true,"example":42},"serviceUniqueName":{"type":"string","nullable":true,"readOnly":true,"example":"github"},"serviceName":{"type":"string","nullable":true,"readOnly":true,"example":"GitHub"},"workspaceName":{"type":"string","nullable":true,"readOnly":true,"example":"mfi"},"accountKey":{"type":"string","nullable":true,"readOnly":true,"example":"foo@mfi.com"},"serviceIsCustom":{"type":"boolean","nullable":true,"readOnly":true,"example":false}},"required":["id","serviceId","serviceUniqueName","serviceName","workspaceName","accountKey","serviceIsCustom"]},"MergedPeopleDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"foo@gmail.com"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"foo"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Yamaha Honda"}},"required":["id","primaryEmail","username","displayName"]},"PeopleResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"identityId":{"type":"string","nullable":true,"readOnly":true,"example":"I3N5HB4B3G"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"foo@gmail.com"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Yamaha Honda"},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar_url"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"foo"},"type":{"type":"string","readOnly":true,"example":"employee"},"status":{"type":"string","readOnly":true,"example":"suspended"},"managementType":{"readOnly":true,"example":"managed","allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"employeeType":{"readOnly":true,"example":"full_time_employee","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"employeeStatus":{"readOnly":true,"example":"active","allOf":[{"$ref":"#/components/schemas/EmployeeStatus"}]},"suspendedAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-13T19:15:40.000Z"},"createdAt":{"type":"string","nullable":true,"readOnly":true,"example":"2021-07-13T19:15:40.000Z"},"accounts":{"nullable":true,"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/CompactPeopleAccountDto"}},"mergedPeople":{"nullable":true,"readOnly":true,"example":[{"id":1,"displayName":"Ron Lee","username":"ron.lee","primaryEmail":null}],"type":"array","items":{"$ref":"#/components/schemas/MergedPeopleDto"}}},"required":["id","identityId","primaryEmail","displayName","avatar","username","type","status","managementType","employeeType","employeeStatus","suspendedAt","createdAt","accounts","mergedPeople"]},"MdmMetadataDto":{"type":"object","properties":{"workspaceId":{"type":"number","readOnly":true,"example":123},"serviceUniqueName":{"type":"string","readOnly":true,"example":"jamf"},"url":{"type":"string","nullable":true,"readOnly":true,"example":"https://example.com"}},"required":["workspaceId","serviceUniqueName","url"]},"DeviceDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":123},"memo":{"type":"string","readOnly":true,"example":"foo bar"},"people":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PeopleResponseDto"}]},"originalPeopleId":{"type":"number","nullable":true,"readOnly":true,"example":456},"fields":{"type":"object","additionalProperties":{"nullable":true,"oneOf":[{"type":"string"},{"type":"number"}]},"readOnly":true,"example":{"preset.subtype":"other","preset.asset_number":"unique value","preset.model_name":"cool gadget","custom.custom_text_field":"foo","custom.custom_date_field":"2024-01-01","custom.custom_number_field":123,"custom.custom_dropdown_field":"Option Displayed Value A"}},"mdmMetadata":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/MdmMetadataDto"}]},"relatedIdentities":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/RelatedIdentitiesDto"}]},"customFieldsWithMetadata":{"readOnly":true,"example":[{"id":1,"attributeCode":"custom_text_field","attributeName":"Text field","value":"foo"},{"id":2,"attributeCode":"custom_date_field","attributeName":"Date field","value":"2024-01-01"},{"id":3,"attributeCode":"custom_number_field","attributeName":"Number field","value":123},{"id":4,"attributeCode":"custom_dropdown_field","attributeName":"Dropdown field","value":"Option Displayed Value A"}],"type":"array","items":{"$ref":"#/components/schemas/CustomFieldWithMetadataDto"}}},"required":["id","memo","people","originalPeopleId","fields","mdmMetadata","relatedIdentities","customFieldsWithMetadata"]},"PublicSearchDevicesResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/DeviceDto"}}},"required":["meta","items"]},"PublicCreateDeviceRequestDto":{"type":"object","properties":{"memo":{"type":"string","example":"foo bar"},"fields":{"type":"object","properties":{"preset.asset_number":{"type":"string","example":"(REQUIRED) - example value"},"preset.subtype":{"type":"string","enum":["desktop_pc","laptop_pc","tablet_pc","phone","monitor","server","peripheral_device","other"],"example":"(REQUIRED) - desktop_pc"},"preset.model_name":{"type":"string","example":"(REQUIRED) - example value"},"preset.serial_number":{"type":"string","example":"example value"},"preset.model_number":{"type":"string","example":"example value"},"preset.memory":{"type":"string","example":"example value"},"preset.hdd_ssd":{"type":"string","example":"example value"},"preset.cpu":{"type":"string","example":"example value"},"preset.os":{"type":"string","example":"example value"},"preset.size":{"type":"string","example":"example value"},"preset.manufacturer":{"type":"string","example":"example value"},"preset.supplier":{"type":"string","example":"example value"},"preset.procurement_method":{"type":"string","enum":["purchase","lease","rental","other"],"example":"purchase"},"preset.purchase_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.purchase_cost":{"type":"number","example":"1234"},"preset.warranty_period":{"type":"string","example":"example value"},"preset.decommission_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.scheduled_return_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.fixed_asset":{"type":"string","enum":["yes","no"],"example":"yes"},"preset.phone_number":{"type":"string","example":"example value"},"preset.sim_number":{"type":"string","example":"example value"},"preset.mobile_plan":{"type":"string","example":"example value"},"preset.hostname":{"type":"string","example":"example value"},"preset.version":{"type":"string","example":"example value"},"preset.keyboard_layout":{"type":"string","enum":["us","uk","jis","other"],"example":"us"},"preset.usage_start_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.usage_end_date":{"type":"string","example":"2012-05-18","format":"date"},"custom.custom_text_field":{"type":"string","example":"foo","description":"This is an example of text field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."},"custom.custom_date_field":{"type":"string","format":"date","example":"2024-01-01","description":"This is an example of date field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."},"custom.custom_number_field":{"type":"number","example":123,"description":"This is an example of number field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."},"custom.custom_dropdown_field":{"type":"string","enum":["Option Displayed Value A","Option Displayed Value B","Option Displayed Value C"],"example":"Option Displayed Value A","description":"This is an example of dropdown field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."}}}},"required":["fields"]},"PublicGetDeviceResponseDto":{"type":"object","properties":{"id":{"type":"number","example":123,"description":"Unique identifier for the device"},"memo":{"type":"string","example":"foo bar","description":"Additional notes or memo about the device"},"type":{"type":"string","enum":["pc","phone","other"],"example":"pc","description":"Type of the device (e.g., PC, Phone, Tablet)"},"people":{"nullable":true,"description":"Person assigned to this device, or null if unassigned","type":"object","allOf":[{"$ref":"#/components/schemas/PublicPeopleResponseDtoWithoutAccounts"}]},"identity":{"nullable":true,"description":"Identity information of the assigned person, or null if unassigned","type":"object","allOf":[{"$ref":"#/components/schemas/PublicSimpleIdentityDto"}]},"preset":{"type":"object","example":{"subtype":"other","price":123.321},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Preset fields for the device. This is a hashmap where the key maps to the field `uniqueName` in device fields."},"custom":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Custom fields for the device. This is a hashmap where the key maps to the field `uniqueName` in device fields."},"createdAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00Z","description":"Timestamp when the device was created"},"updatedAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00Z","description":"Timestamp when the device was last updated"},"customFieldsWithMetadata":{"readOnly":true,"example":[{"id":1,"attributeCode":"custom_text_field","attributeName":"Text field","value":"foo"},{"id":2,"attributeCode":"custom_date_field","attributeName":"Date field","value":"2024-01-01"},{"id":3,"attributeCode":"custom_number_field","attributeName":"Number field","value":123},{"id":4,"attributeCode":"custom_dropdown_field","attributeName":"Dropdown field","value":"Option Displayed Value A"}],"type":"array","items":{"$ref":"#/components/schemas/CustomFieldWithMetadataDto"}}},"required":["id","memo","type","people","identity","preset","custom","createdAt","updatedAt","customFieldsWithMetadata"]},"PublicCreateDevicesBulkRequestDto":{"type":"object","properties":{"devices":{"description":"Array of devices to create. Maximum 50 devices per request.","type":"array","items":{"$ref":"#/components/schemas/PublicCreateDeviceRequestDto"}}},"required":["devices"]},"PublicCreateDevicesBulkListResponseDto":{"type":"object","properties":{"devices":{"description":"List of created devices","type":"array","items":{"$ref":"#/components/schemas/PublicDeviceDto"}}},"required":["devices"]},"DeviceStatus":{"type":"string","enum":["in_stock","pre_use","active","missing","malfunction","decommissioned","on_order"]},"PublicDeleteDevicesBulkRequestDto":{"type":"object","properties":{"deviceIds":{"example":[1,2,3],"description":"Array of device IDs to delete. Maximum 100 IDs per request.","type":"array","items":{"type":"number"}}},"required":["deviceIds"]},"DeviceHistoryChangesDto":{"type":"object","properties":{"people":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PeopleResponseDto"}]},"status":{"example":"decommissioned","allOf":[{"$ref":"#/components/schemas/DeviceStatus"}]},"location1":{"type":"string","example":"Tokyo","nullable":true},"location2":{"type":"string","example":"msb","nullable":true},"assignmentStartDate":{"type":"string","format":"date","example":"2021-01-01","nullable":true},"assignmentEndDate":{"type":"string","format":"date","example":"2022-01-02","nullable":true},"comment":{"type":"string","example":"Assigned to new employee","nullable":true}},"required":["people","status","location1","location2","assignmentStartDate","assignmentEndDate","comment"]},"PublicGetDeviceHistoryResponseDto":{"type":"object","properties":{"id":{"type":"number","example":123},"deviceId":{"type":"number","example":321},"createdAt":{"type":"string","format":"date-time","example":"2017-07-21T17:32:28Z"},"changes":{"$ref":"#/components/schemas/DeviceHistoryChangesDto"},"comment":{"type":"string","example":"Assigned to new employee","nullable":true}},"required":["id","deviceId","createdAt","changes","comment"]},"PublicDeviceWithHistoryDto":{"type":"object","properties":{"id":{"type":"number","example":123,"description":"Unique identifier for the device"},"memo":{"type":"string","example":"foo bar","description":"Additional notes or memo about the device"},"type":{"type":"string","enum":["pc","phone","other"],"example":"pc","description":"Type of the device (e.g., PC, Phone, Tablet)"},"people":{"nullable":true,"description":"Person assigned to this device, or null if unassigned","type":"object","allOf":[{"$ref":"#/components/schemas/PublicPeopleResponseDtoWithoutAccounts"}]},"identity":{"nullable":true,"description":"Identity information of the assigned person, or null if unassigned","type":"object","allOf":[{"$ref":"#/components/schemas/PublicSimpleIdentityDto"}]},"preset":{"type":"object","example":{"subtype":"other","price":123.321},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Preset fields for the device. This is a hashmap where the key maps to the field `uniqueName` in device fields."},"custom":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Custom fields for the device. This is a hashmap where the key maps to the field `uniqueName` in device fields."},"createdAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00Z","description":"Timestamp when the device was created"},"updatedAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00Z","description":"Timestamp when the device was last updated"},"customFieldsWithMetadata":{"readOnly":true,"example":[{"id":1,"attributeCode":"custom_text_field","attributeName":"Text field","value":"foo"},{"id":2,"attributeCode":"custom_date_field","attributeName":"Date field","value":"2024-01-01"},{"id":3,"attributeCode":"custom_number_field","attributeName":"Number field","value":123},{"id":4,"attributeCode":"custom_dropdown_field","attributeName":"Dropdown field","value":"Option Displayed Value A"}],"type":"array","items":{"$ref":"#/components/schemas/CustomFieldWithMetadataDto"}},"histories":{"description":"History of changes made to this device","type":"array","items":{"$ref":"#/components/schemas/PublicGetDeviceHistoryResponseDto"}}},"required":["id","memo","type","people","identity","preset","custom","createdAt","updatedAt","customFieldsWithMetadata","histories"]},"PublicDeleteDevicesResponseDto":{"type":"object","properties":{"deletedDevicesWithHistory":{"description":"List of deleted devices with their history","type":"array","items":{"$ref":"#/components/schemas/PublicDeviceWithHistoryDto"}}},"required":["deletedDevicesWithHistory"]},"PublicUpdateDeviceRequestDto":{"type":"object","properties":{"memo":{"type":"string","example":"foo bar"},"fields":{"type":"object","properties":{"preset.asset_number":{"type":"string","example":"(REQUIRED) - example value"},"preset.subtype":{"type":"string","enum":["desktop_pc","laptop_pc","tablet_pc","phone","monitor","server","peripheral_device","other"],"example":"(REQUIRED) - desktop_pc"},"preset.model_name":{"type":"string","example":"(REQUIRED) - example value"},"preset.serial_number":{"type":"string","example":"example value"},"preset.model_number":{"type":"string","example":"example value"},"preset.memory":{"type":"string","example":"example value"},"preset.hdd_ssd":{"type":"string","example":"example value"},"preset.cpu":{"type":"string","example":"example value"},"preset.os":{"type":"string","example":"example value"},"preset.size":{"type":"string","example":"example value"},"preset.manufacturer":{"type":"string","example":"example value"},"preset.supplier":{"type":"string","example":"example value"},"preset.procurement_method":{"type":"string","enum":["purchase","lease","rental","other"],"example":"purchase"},"preset.purchase_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.purchase_cost":{"type":"number","example":"1234"},"preset.warranty_period":{"type":"string","example":"example value"},"preset.decommission_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.scheduled_return_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.fixed_asset":{"type":"string","enum":["yes","no"],"example":"yes"},"preset.phone_number":{"type":"string","example":"example value"},"preset.sim_number":{"type":"string","example":"example value"},"preset.mobile_plan":{"type":"string","example":"example value"},"preset.hostname":{"type":"string","example":"example value"},"preset.version":{"type":"string","example":"example value"},"preset.keyboard_layout":{"type":"string","enum":["us","uk","jis","other"],"example":"us"},"preset.usage_start_date":{"type":"string","example":"2012-05-18","format":"date"},"preset.usage_end_date":{"type":"string","example":"2012-05-18","format":"date"},"custom.custom_text_field":{"type":"string","example":"foo","description":"This is an example of text field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."},"custom.custom_date_field":{"type":"string","format":"date","example":"2024-01-01","description":"This is an example of date field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."},"custom.custom_number_field":{"type":"number","example":123,"description":"This is an example of number field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."},"custom.custom_dropdown_field":{"type":"string","enum":["Option Displayed Value A","Option Displayed Value B","Option Displayed Value C"],"example":"Option Displayed Value A","description":"This is an example of dropdown field. Please refer to `GET /api/v1alpha/organizations/{organizationId}/devices/fields/all` to get the list of all available custom fields.."}}}},"required":["fields"]},"PublicGetDevicesStatsResponseDto":{"type":"object","properties":{"total":{"type":"number","readOnly":true,"example":123},"active":{"type":"number","readOnly":true,"example":123},"inStock":{"type":"number","readOnly":true,"example":123},"preUse":{"type":"number","readOnly":true,"example":123},"decommissioned":{"type":"number","readOnly":true,"example":123},"malfunction":{"type":"number","readOnly":true,"example":123},"onOrder":{"type":"number","readOnly":true,"example":123},"missing":{"type":"number","readOnly":true,"example":123},"urgent":{"type":"number","readOnly":true,"example":123}},"required":["total","active","inStock","preUse","decommissioned","malfunction","onOrder","missing","urgent"]},"DevicePresetFieldUniqueName":{"type":"string","enum":["asset_number","subtype","model_name","status","serial_number","model_number","memory","hdd_ssd","cpu","os","size","manufacturer","supplier","procurement_method","purchase_date","purchase_cost","warranty_period","decommission_date","scheduled_return_date","location_1","location_2","assignment_start_date","assignment_end_date","fixed_asset","phone_number","sim_number","mobile_plan","hostname","version","keyboard_layout","usage_start_date","usage_end_date","last_activity_from_mdm"]},"PublicDeviceInsightsResponseDto":{"type":"object","properties":{"key":{"type":"string","readOnly":true},"count":{"type":"number","readOnly":true}},"required":["key","count"]},"DeviceMultiLanguageNameDto":{"type":"object","properties":{"ja":{"type":"string","readOnly":true,"example":"こんにちは"},"en":{"type":"string","readOnly":true,"example":"Hello"}},"required":["ja","en"]},"DeviceFieldDropdownValueDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"option_1"},"group":{"type":"string","readOnly":true,"example":"phone"},"label":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/DeviceMultiLanguageNameDto"}]},"value":{"type":"string","readOnly":true,"example":"phone"}},"required":["id","value"]},"DeviceFieldDropdownGroupDto":{"type":"object","properties":{"label":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/DeviceMultiLanguageNameDto"}]},"value":{"type":"string","readOnly":true,"example":"phone"}},"required":["value"]},"DeviceFieldDropdownConfigurationDto":{"type":"object","properties":{"values":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/DeviceFieldDropdownValueDto"}},"groups":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/DeviceFieldDropdownGroupDto"}}},"required":["values","groups"]},"DeviceFieldKind":{"type":"string","enum":["text","date","number","dropdown"],"description":"The type of field (e.g., text, number, date, dropdown)"},"PublicDevicePresetFieldDto":{"type":"object","properties":{"uniqueName":{"type":"string","example":"serial_number","description":"Unique identifier for the device field"},"name":{"description":"Multi-language names for the field","allOf":[{"$ref":"#/components/schemas/DeviceMultiLanguageNameDto"}]},"kind":{"example":"dropdown","description":"The type of field (e.g., text, number, date, dropdown)","allOf":[{"$ref":"#/components/schemas/DeviceFieldKind"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/DeviceFieldDropdownConfigurationDto"}],"nullable":true,"description":"Additional configuration for the field, such as dropdown options"},"visibleForType":{"type":"array","example":"phone","description":"List of device types this field is visible for","items":{"$ref":"#/components/schemas/DeviceType"}},"required":{"type":"boolean","example":true,"description":"Indicates if this field is required"}},"required":["uniqueName","name","kind","configuration","visibleForType","required"]},"PublicGetDeviceWorkspaceStatusResponseDto":{"type":"object","properties":{"haveDeviceDisabledWs":{"type":"boolean","readOnly":true},"haveAnyMdmSyncingWorkspace":{"type":"boolean","readOnly":true},"haveAnyMdmSyncableWorkspace":{"type":"boolean","readOnly":true}},"required":["haveDeviceDisabledWs","haveAnyMdmSyncingWorkspace","haveAnyMdmSyncableWorkspace"]},"CreateDeviceFieldDropdownValueDto":{"type":"object","properties":{"id":{"type":"string","example":"option_1"},"value":{"type":"string","example":"Option 1"},"group":{"type":"string"}},"required":["id","value"]},"CreateDeviceFieldDropdownConfigurationDto":{"type":"object","properties":{"values":{"description":"Dropdown items with id (stable identifier) and value (display name)","type":"array","items":{"$ref":"#/components/schemas/CreateDeviceFieldDropdownValueDto"}}},"required":["values"]},"PublicGetDeviceCustomFieldResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"kind":{"example":"dropdown","allOf":[{"$ref":"#/components/schemas/DeviceFieldKind"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/DeviceFieldDropdownConfigurationDto"}],"nullable":true},"visibleForType":{"type":"array","example":"phone","items":{"$ref":"#/components/schemas/DeviceType"}},"required":{"type":"boolean","description":"This field will be always `false` in R1","readOnly":true,"example":true},"attributeCode":{"type":"string","readOnly":true,"example":"custom_text_field"},"attributeName":{"type":"string","readOnly":true,"example":"Foo bar"}},"required":["id","kind","configuration","visibleForType","required","attributeCode","attributeName"]},"PublicGetDeviceCustomFieldsListResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicGetDeviceCustomFieldResponseDto"}}},"required":["items"]},"PublicCreateDeviceCustomFieldRequestDto":{"type":"object","properties":{"kind":{"example":"dropdown","allOf":[{"$ref":"#/components/schemas/DeviceFieldKind"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CreateDeviceFieldDropdownConfigurationDto"}],"nullable":true},"attributeName":{"type":"string","example":"foo bar"},"attributeCode":{"type":"string","example":"device_id","description":"Unique identifier for the custom field. Must contain only lowercase letters, numbers, and underscores. If not provided, will be auto-generated."}},"required":["kind","configuration","attributeName"]},"GetDeviceCustomFieldResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"uniqueName":{"type":"string","readOnly":true,"example":"custom_text_field"},"name":{"type":"string","readOnly":true,"example":"Foo bar"},"kind":{"example":"dropdown","allOf":[{"$ref":"#/components/schemas/DeviceFieldKind"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/DeviceFieldDropdownConfigurationDto"}],"nullable":true},"visibleForType":{"type":"array","example":"phone","items":{"$ref":"#/components/schemas/DeviceType"}},"required":{"type":"boolean","description":"This field will be always `false` in R1","readOnly":true,"example":true}},"required":["id","uniqueName","name","kind","configuration","visibleForType","required"]},"PublicUpdateDeviceCustomFieldRequestDto":{"type":"object","properties":{"visibleForType":{"type":"array","example":"phone","items":{"$ref":"#/components/schemas/DeviceType"}},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CreateDeviceFieldDropdownConfigurationDto"}],"nullable":true,"description":"Update the dropdown configuration (values can be added, removed, reordered, or modified)"},"attributeName":{"type":"string","example":"foo bar"},"attributeCode":{"type":"string","example":"device_id","description":"Unique identifier for the custom field. Must contain only lowercase letters, numbers, and underscores. Cannot be changed to a value that already exists in the organization."}}},"PublicDepartmentDto":{"type":"object","properties":{"name":{"type":"string","example":"department_name"}},"required":["name"]},"PublicGetDepartmentsResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicDepartmentDto"}}},"required":["items"]},"PublicLocationDto":{"type":"object","properties":{"name":{"type":"string","example":"location_name"}},"required":["name"]},"PublicGetLocationsResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicLocationDto"}}},"required":["items"]},"PublicCompanyDto":{"type":"object","properties":{"name":{"type":"string","example":"company_name"}},"required":["name"]},"PublicGetCompaniesResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicCompanyDto"}}},"required":["items"]},"LifecycleDtoElement":{"type":"object","properties":{"contractStartAt":{"format":"date","type":"string","example":"2021-01-01","description":"Contract start date of the employee. Date-only strings (e.g. \"2021-01-01\") are interpreted as UTC midnight. To specify a local midnight in a specific timezone, provide a full ISO 8601 datetime with offset (e.g. \"2020-12-31T15:00:00.000Z\" for 2021-01-01 00:00 JST).","nullable":true},"contractEndAt":{"format":"date","type":"string","example":"2021-01-02","description":"Contract end date of the employee. Date-only strings (e.g. \"2021-01-02\") are interpreted as UTC midnight. To specify a local midnight in a specific timezone, provide a full ISO 8601 datetime with offset (e.g. \"2021-01-01T15:00:00.000Z\" for 2021-01-02 00:00 JST).","nullable":true},"suspensionStartAt":{"format":"date","type":"string","example":"2021-01-01","description":"Suspension start date of the employee. Date-only strings (e.g. \"2021-01-01\") are interpreted as UTC midnight. To specify a local midnight in a specific timezone, provide a full ISO 8601 datetime with offset (e.g. \"2020-12-31T15:00:00.000Z\" for 2021-01-01 00:00 JST).","nullable":true},"suspensionEndAt":{"format":"date","type":"string","example":"2021-01-03","description":"Suspension end date of the employee. Date-only strings (e.g. \"2021-01-03\") are interpreted as UTC midnight. To specify a local midnight in a specific timezone, provide a full ISO 8601 datetime with offset (e.g. \"2021-01-02T15:00:00.000Z\" for 2021-01-03 00:00 JST).","nullable":true}}},"PublicUpdateIdentityManagerDto":{"type":"object","properties":{"id":{"type":"string","description":"Manager ID","nullable":true}}},"PublicCreateIdentityDto":{"type":"object","properties":{"employeeStatus":{"example":"active","description":"Extended status of the employee","allOf":[{"$ref":"#/components/schemas/ExtendedEmployeeStatus"}]},"employeeType":{"example":"full_time_employee","description":"Type of the employee","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"managementType":{"example":"managed","description":"Management type of the employee","nullable":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"displayName":{"type":"string","example":"Display Name","description":"Display name of the employee","nullable":true},"firstName":{"type":"string","example":"First Name","description":"First name of the employee","nullable":true},"lastName":{"type":"string","example":"Last Name","description":"Last name of the employee","nullable":true},"primaryEmail":{"type":"string","example":"primay@email.com","description":"Primary email of the employee","nullable":true},"secondaryEmails":{"example":["secondary+1@email.com","secondary+2@email.com"],"description":"Secondary emails of the employee","nullable":true,"type":"array","items":{"type":"string"}},"companyName":{"type":"string","example":"company name","description":"Company name of the employee","nullable":true},"workLocation":{"type":"string","example":"work location","description":"Work location of the employee","nullable":true},"department":{"description":"Department of the employee","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepartmentDtoElement"}]},"jobTitle":{"type":"string","example":"CTO","description":"Job title of the employee","nullable":true},"employeeId":{"type":"string","example":"EMP12345","description":"Employee ID of the employee","nullable":true},"lifecycle":{"description":"Lifecycle of the employee","allOf":[{"$ref":"#/components/schemas/LifecycleDtoElement"}]},"note":{"type":"string","example":"this is a note","description":"Notes of the employee","nullable":true},"customFields":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"nullable":true},"description":"Custom fields of the employee"},"manager":{"description":"Manager of the employee","allOf":[{"$ref":"#/components/schemas/PublicUpdateIdentityManagerDto"}]}},"required":["employeeStatus","employeeType","firstName","lastName"]},"PeopleSimpleResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"identityId":{"type":"string","nullable":true,"readOnly":true,"example":"I3N5HB4B3G"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"foo@gmail.com"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"Yamaha Honda"},"avatar":{"type":"string","nullable":true,"readOnly":true,"example":"avatar_url"},"username":{"type":"string","nullable":true,"readOnly":true,"example":"foo"},"status":{"type":"string","readOnly":true,"example":"suspended"},"type":{"readOnly":true,"example":"employee","allOf":[{"$ref":"#/components/schemas/PeopleType"}]}},"required":["id","identityId","primaryEmail","displayName","avatar","username","status","type"]},"ManagerDto":{"type":"object","properties":{"id":{"type":"string","description":"Manager ID","nullable":true},"displayName":{"type":"string","description":"Manager name","nullable":true},"people":{"description":"People of the manager","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PeopleSimpleResponseDto"}]}}},"StructureInfo":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"name"}},"required":["id","name"]},"StructureManagerDto":{"type":"object","properties":{"id":{"type":"string","description":"Identity ID"},"displayName":{"type":"string","description":"Identity display name"},"primaryEmail":{"type":"string","description":"Identity primary email"},"avatar":{"type":"string","description":"Avatar URL"}},"required":["id","displayName","primaryEmail","avatar"]},"IdentityStructuresInfoDto":{"type":"object","properties":{"companies":{"description":"Companies that the identity is a member of","type":"array","items":{"$ref":"#/components/schemas/StructureInfo"}},"departments":{"description":"Departments that the identity is a member of","type":"array","items":{"$ref":"#/components/schemas/StructureInfo"}},"locations":{"description":"Locations that the identity is a member of","type":"array","items":{"$ref":"#/components/schemas/StructureInfo"}},"managers":{"description":"Managers of this identity","type":"array","items":{"$ref":"#/components/schemas/StructureManagerDto"}}},"required":["companies","departments","locations","managers"]},"PublicIdentityDto":{"type":"object","properties":{"id":{"type":"string","description":"ID of the employee"},"organizationId":{"type":"number","description":"ID of the organization"},"peopleId":{"type":"string","description":"ID of the people"},"employeeStatus":{"example":"active","description":"Extended status of the employee","allOf":[{"$ref":"#/components/schemas/ExtendedEmployeeStatus"}]},"employeeType":{"example":"full_time_employee","description":"Type of the employee","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"managementType":{"example":"managed","description":"Management type of the employee","nullable":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"displayName":{"type":"string","example":"Display Name","description":"Display name of the employee","nullable":true},"firstName":{"type":"string","example":"First Name","description":"First name of the employee","nullable":true},"lastName":{"type":"string","example":"Last Name","description":"Last name of the employee","nullable":true},"avatar":{"type":"string","description":"URL of the avatar of the employee","nullable":true},"primaryEmail":{"type":"string","example":"primay@email.com","description":"Primary email of the employee","nullable":true},"secondaryEmails":{"example":["secondary+1@email.com","secondary+2@email.com"],"description":"Secondary emails of the employee","nullable":true,"type":"array","items":{"type":"string"}},"companyName":{"type":"string","example":"company name","description":"Company name of the employee","nullable":true},"workLocation":{"type":"string","example":"work location","description":"Work location of the employee","nullable":true},"department":{"description":"Department of the employee","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepartmentDtoElement"}]},"serviceCount":{"type":"number","description":"Number of services the employee has","nullable":true},"deviceCount":{"type":"number","description":"Number of devices the employee has","nullable":true},"costs":{"description":"Costs of the employee","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityCost"}},"createdAt":{"format":"date-time","type":"string","description":"Record created at","nullable":true},"updatedAt":{"format":"date-time","type":"string","description":"Record updated at","nullable":true},"isManager":{"type":"boolean","description":"Is the employee a manager","nullable":true},"isMock":{"type":"boolean","description":"Indicates if the identity is a mock"},"isEmailEditable":{"type":"boolean","description":"Indicates if the email of the identity is editable","nullable":true},"hasPresetFieldsUnlinked":{"type":"boolean","description":"Indicates if the unlink preset fields is enabled","nullable":true},"jobTitle":{"type":"string","example":"CTO","description":"Job title of the employee","nullable":true},"employeeId":{"type":"string","example":"EMP12345","description":"Employee ID of the employee","nullable":true},"lifecycle":{"description":"Lifecycle of the employee","allOf":[{"$ref":"#/components/schemas/LifecycleDtoElement"}]},"manager":{"description":"Manager of the employee","allOf":[{"$ref":"#/components/schemas/ManagerDto"}]},"note":{"type":"string","example":"this is a note","description":"Notes of the employee","nullable":true},"profileUrl":{"type":"string","example":"https://workspace.url/employee/12345","description":"URL of the profile of the employee","format":"uri","nullable":true},"customFields":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"nullable":true},"description":"Custom fields of the employee"},"customFieldsWithMetadata":{"description":"Custom fields with metadata including ID, uniqueName, and label","example":[{"id":1,"attributeCode":"custom_text_field","attributeName":"Text field","value":"foo"},{"id":2,"attributeCode":"custom_date_field","attributeName":"Date field","value":"2024-01-01"},{"id":3,"attributeCode":"custom_number_field","attributeName":"Number field","value":123},{"id":4,"attributeCode":"custom_dropdown_field","attributeName":"Dropdown field","value":"Option Displayed Value A"}],"type":"array","items":{"$ref":"#/components/schemas/CustomFieldWithMetadataDto"}},"structuresInfo":{"description":"Structures that the identity is a member of, categorized by type","allOf":[{"$ref":"#/components/schemas/IdentityStructuresInfoDto"}]}},"required":["employeeStatus","employeeType","firstName","lastName"]},"IdentitySortBy":{"type":"string","enum":["name","type","status","company","department","location","servicesCount","devicesCount","costUsd","costJpy","employeeId","contractStart","contractEnd","suspensionStart","suspensionEnd","createdAt","updatedAt","jobTitle"]},"IdentityExpand":{"type":"string","enum":["devices","accounts","customFieldsMetadata","relatedIdentity"]},"PublicGetIdentitiesResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicIdentityDto"}}},"required":["meta","items"]},"PublicCheckIdentitiesManagementTypeResponseDto":{"type":"object","properties":{"type":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]}},"required":["type"]},"ManagementTypeDto":{"type":"object","properties":{"type":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"count":{"type":"number","readOnly":true}},"required":["type","count"]},"HrMasterStatistic":{"type":"object","properties":{"workspaceId":{"type":"number","readOnly":true},"serviceId":{"type":"number","readOnly":true},"serviceUniqueName":{"type":"string","readOnly":true},"lastSynchronizationAt":{"format":"date-time","type":"string","nullable":true,"readOnly":true},"serviceName":{"type":"string","readOnly":true}},"required":["workspaceId","serviceId","serviceUniqueName","lastSynchronizationAt","serviceName"]},"PublicGetIdentitiesStatisticsResponseDto":{"type":"object","properties":{"managementTypes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ManagementTypeDto"}},"hrMasters":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/HrMasterStatistic"}},"domains":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["managementTypes","hrMasters","domains"]},"ActionType":{"type":"string","enum":["create","update","merge","unmerge"]},"ActionSource":{"type":"string","enum":["ui","api","csv","synchronization","domain_settings"]},"HistoryIdentityDto":{"type":"object","properties":{"id":{"type":"string","description":"Identity ID"},"displayName":{"type":"string","description":"Identity display name","nullable":true},"primaryEmail":{"type":"string","description":"Identity primary email","nullable":true}},"required":["id"]},"ActionMetadataElement":{"type":"object","properties":{"targetIdentity":{"description":"Target identity","allOf":[{"$ref":"#/components/schemas/HistoryIdentityDto"}]},"sourceIdentity":{"description":"Source identity","allOf":[{"$ref":"#/components/schemas/HistoryIdentityDto"}]},"iggreRequestId":{"type":"string","description":"Iggre Request ID, only present for aggregation actions"}},"required":["targetIdentity","sourceIdentity","iggreRequestId"]},"IdentityHistoryByChangeDto":{"type":"object","properties":{"id":{"type":"string"},"field":{"type":"string"},"previous":{"type":"string"},"current":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/ActionType"}]},"source":{"allOf":[{"$ref":"#/components/schemas/ActionSource"}]},"actor":{"type":"string"},"metadata":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ActionMetadataElement"}]},"createdAt":{"type":"string"}}},"PublicIdentityHistoryByChangeResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityHistoryByChangeDto"}}},"required":["meta","items"]},"BulkIdentityDto":{"type":"object","properties":{"id":{"type":"string","description":"ID of the employee"},"organizationId":{"type":"number","description":"ID of the organization"},"peopleId":{"type":"string","description":"ID of the people"},"employeeStatus":{"example":"active","description":"Extended status of the employee","allOf":[{"$ref":"#/components/schemas/ExtendedEmployeeStatus"}]},"employeeType":{"example":"full_time_employee","description":"Type of the employee","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"managementType":{"example":"managed","description":"Management type of the employee","nullable":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"displayName":{"type":"string","example":"Display Name","description":"Display name of the employee","nullable":true},"firstName":{"type":"string","example":"First Name","description":"First name of the employee","nullable":true},"lastName":{"type":"string","example":"Last Name","description":"Last name of the employee","nullable":true},"avatar":{"type":"string","description":"URL of the avatar of the employee","nullable":true},"primaryEmail":{"type":"string","example":"primay@email.com","description":"Primary email of the employee","nullable":true},"secondaryEmails":{"example":["secondary+1@email.com","secondary+2@email.com"],"description":"Secondary emails of the employee","nullable":true,"type":"array","items":{"type":"string"}},"companyName":{"type":"string","example":"company name","description":"Company name of the employee","nullable":true},"workLocation":{"type":"string","example":"work location","description":"Work location of the employee","nullable":true},"department":{"description":"Department of the employee","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepartmentDtoElement"}]},"serviceCount":{"type":"number","description":"Number of services the employee has","nullable":true},"deviceCount":{"type":"number","description":"Number of devices the employee has","nullable":true},"costs":{"description":"Costs of the employee","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityCost"}},"createdAt":{"format":"date-time","type":"string","description":"Record created at","nullable":true},"updatedAt":{"format":"date-time","type":"string","description":"Record updated at","nullable":true},"isManager":{"type":"boolean","description":"Is the employee a manager","nullable":true},"isMock":{"type":"boolean","description":"Indicates if the identity is a mock"},"isEmailEditable":{"type":"boolean","description":"Indicates if the email of the identity is editable","nullable":true},"hasPresetFieldsUnlinked":{"type":"boolean","description":"Indicates if the unlink preset fields is enabled","nullable":true},"jobTitle":{"type":"string","example":"CTO","description":"Job title of the employee","nullable":true},"employeeId":{"type":"string","example":"EMP12345","description":"Employee ID of the employee","nullable":true},"lifecycle":{"description":"Lifecycle of the employee","allOf":[{"$ref":"#/components/schemas/LifecycleDtoElement"}]},"manager":{"description":"Manager of the employee","allOf":[{"$ref":"#/components/schemas/ManagerDto"}]},"note":{"type":"string","example":"this is a note","description":"Notes of the employee","nullable":true},"profileUrl":{"type":"string","example":"https://workspace.url/employee/12345","description":"URL of the profile of the employee","format":"uri","nullable":true},"customFields":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"nullable":true},"description":"Custom fields of the employee"},"customFieldsWithMetadata":{"description":"Custom fields with metadata including ID, uniqueName, and label","example":[{"id":1,"attributeCode":"custom_text_field","attributeName":"Text field","value":"foo"},{"id":2,"attributeCode":"custom_date_field","attributeName":"Date field","value":"2024-01-01"},{"id":3,"attributeCode":"custom_number_field","attributeName":"Number field","value":123},{"id":4,"attributeCode":"custom_dropdown_field","attributeName":"Dropdown field","value":"Option Displayed Value A"}],"type":"array","items":{"$ref":"#/components/schemas/CustomFieldWithMetadataDto"}},"structuresInfo":{"description":"Structures that the identity is a member of, categorized by type","allOf":[{"$ref":"#/components/schemas/IdentityStructuresInfoDto"}]}}},"BulkUpdateIdentitiesDto":{"type":"object","properties":{"identityIds":{"description":"Array of identity IDs to update","example":["identity-1","identity-2"],"type":"array","items":{"type":"string"}},"identityUpdates":{"description":"Identity updates to apply to all selected identities. All fields are optional.","allOf":[{"$ref":"#/components/schemas/BulkIdentityDto"}]}},"required":["identityIds","identityUpdates"]},"MergePeopleRequestDto":{"type":"object","properties":{"merges":{"type":"array","items":{"$ref":"#/components/schemas/MergePeopleDto"}}},"required":["merges"]},"UnmergeIdentityRequestDto":{"type":"object","properties":{"peopleIds":{"example":[1,2,3],"description":"List of people IDs to unmerge.","type":"array","items":{"type":"number"}},"identityIds":{"example":["identity-1","identity-2","identity-3"],"description":"List of identity IDs to unmerge.","type":"array","items":{"type":"string"}}}},"PublicUpdateIdentityDto":{"type":"object","properties":{"employeeStatus":{"example":"active","description":"Extended status of the employee","allOf":[{"$ref":"#/components/schemas/ExtendedEmployeeStatus"}]},"employeeType":{"example":"full_time_employee","description":"Type of the employee","allOf":[{"$ref":"#/components/schemas/EmployeeType"}]},"managementType":{"example":"managed","description":"Management type of the employee","nullable":true,"allOf":[{"$ref":"#/components/schemas/ManagementType"}]},"displayName":{"type":"string","example":"Display Name","description":"Display name of the employee","nullable":true},"firstName":{"type":"string","example":"First Name","description":"First name of the employee","nullable":true},"lastName":{"type":"string","example":"Last Name","description":"Last name of the employee","nullable":true},"primaryEmail":{"type":"string","example":"primay@email.com","description":"Primary email of the employee","nullable":true},"secondaryEmails":{"example":["secondary+1@email.com","secondary+2@email.com"],"description":"Secondary emails of the employee","nullable":true,"type":"array","items":{"type":"string"}},"companyName":{"type":"string","example":"company name","description":"Company name of the employee","nullable":true},"workLocation":{"type":"string","example":"work location","description":"Work location of the employee","nullable":true},"department":{"description":"Department of the employee","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepartmentDtoElement"}]},"jobTitle":{"type":"string","example":"CTO","description":"Job title of the employee","nullable":true},"employeeId":{"type":"string","example":"EMP12345","description":"Employee ID of the employee","nullable":true},"lifecycle":{"description":"Lifecycle of the employee","allOf":[{"$ref":"#/components/schemas/LifecycleDtoElement"}]},"note":{"type":"string","example":"this is a note","description":"Notes of the employee","nullable":true},"customFields":{"type":"object","example":{"custom_text_field":"foo","custom_date_field":"2024-01-01","custom_number_field":123,"custom_dropdown_field":"Option Displayed Value A"},"additionalProperties":{"nullable":true},"description":"Custom fields of the employee"},"manager":{"description":"Manager of the employee","allOf":[{"$ref":"#/components/schemas/PublicUpdateIdentityManagerDto"}]}},"required":["employeeStatus","employeeType","firstName","lastName"]},"GetSingleIdentityExpand":{"type":"string","enum":["customFieldsMetadata"]},"CreateIdentityFieldDropdownItemDto":{"type":"object","properties":{"id":{"type":"string","example":"option_1"},"value":{"type":"string","example":"Option 1"},"group":{"type":"string"}},"required":["id","value"]},"CreateIdentityFieldDropdownConfigurationDto":{"type":"object","properties":{"values":{"description":"Dropdown items with id (stable identifier) and value (display name)","type":"array","items":{"$ref":"#/components/schemas/CreateIdentityFieldDropdownItemDto"}}},"required":["values"]},"IdentityFieldKind":{"type":"string","enum":["text","textarea","date","number","dropdown","email"]},"ServiceSourceDto":{"type":"object","properties":{"workspaceId":{"type":"number","readOnly":true,"example":1},"serviceFieldId":{"type":"string","readOnly":true,"example":"smarthr_city"}},"required":["workspaceId","serviceFieldId"]},"ServiceDetailsDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":33},"name":{"type":"string","readOnly":true,"example":"SmartHR"},"uniqueName":{"type":"string","readOnly":true,"example":"smarthr"},"serviceTopUrl":{"type":"string","nullable":true,"readOnly":true,"example":"https://smarthr.jp/"}},"required":["id","name","uniqueName","serviceTopUrl"]},"PublicGetIdentityCustomFieldResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"kind":{"example":"dropdown","allOf":[{"$ref":"#/components/schemas/IdentityFieldKind"}]},"serviceSource":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceSourceDto"}]},"serviceDetails":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceDetailsDto"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/IdentityFieldDropdownConfigurationDto"}],"nullable":true},"required":{"type":"boolean","description":"This field will be always `false` in R1","readOnly":true,"example":true},"attributeCode":{"type":"string","readOnly":true,"example":"custom_text_field"},"attributeName":{"type":"string","readOnly":true,"example":"Foo bar"}},"required":["id","kind","serviceSource","serviceDetails","configuration","required","attributeCode","attributeName"]},"SuggestedCustomFieldWorkspaceDto":{"type":"object","properties":{"workspaceId":{"type":"number","readOnly":true},"workspaceName":{"type":"string","readOnly":true},"serviceId":{"type":"number","readOnly":true},"serviceUniqueName":{"type":"string","readOnly":true},"serviceName":{"type":"string","readOnly":true}},"required":["workspaceId","workspaceName","serviceId","serviceUniqueName","serviceName"]},"PublicGetIdentityCustomFieldsListResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicGetIdentityCustomFieldResponseDto"}},"availableSourceWorkspaces":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/SuggestedCustomFieldWorkspaceDto"}}},"required":["items","availableSourceWorkspaces"]},"CreateServiceSourceMetadataDto":{"type":"object","properties":{"serviceFieldId":{"type":"string","example":"service_field_id"},"workspaceId":{"type":"number","example":1}},"required":["serviceFieldId","workspaceId"]},"PublicCreateIdentityCustomFieldRequestDto":{"type":"object","properties":{"kind":{"example":"dropdown","allOf":[{"$ref":"#/components/schemas/IdentityFieldKind"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CreateIdentityFieldDropdownConfigurationDto"}],"nullable":true},"serviceSource":{"$ref":"#/components/schemas/CreateServiceSourceMetadataDto"},"attributeName":{"type":"string","example":"foo bar"},"attributeCode":{"type":"string","example":"employee_id","description":"Unique identifier for the custom field. Must contain only lowercase letters, numbers, and underscores. If not provided, will be auto-generated."}},"required":["kind","configuration","attributeName"]},"IdentityMultiLanguageNameDto":{"type":"object","properties":{"ja":{"type":"string","readOnly":true,"example":"こんにちは"},"en":{"type":"string","readOnly":true,"example":"Hello"}},"required":["ja","en"]},"IdentityFieldDropdownItemDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"option_1"},"value":{"type":"string","readOnly":true,"example":"Option 1"},"group":{"type":"string"},"label":{"$ref":"#/components/schemas/IdentityMultiLanguageNameDto"}},"required":["id","value"]},"IdentityFieldDropdownGroupDto":{"type":"object","properties":{"label":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/IdentityMultiLanguageNameDto"}]},"value":{"type":"string","readOnly":true,"example":"phone"}},"required":["value"]},"IdentityFieldDropdownConfigurationDto":{"type":"object","properties":{"values":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityFieldDropdownItemDto"}},"groups":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/IdentityFieldDropdownGroupDto"}}},"required":["values","groups"]},"GetIdentityCustomFieldResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"uniqueName":{"type":"string","readOnly":true,"example":"custom_text_field"},"name":{"type":"string","readOnly":true,"example":"Foo bar"},"kind":{"example":"dropdown","allOf":[{"$ref":"#/components/schemas/IdentityFieldKind"}]},"serviceSource":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceSourceDto"}]},"serviceDetails":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceDetailsDto"}]},"configuration":{"type":"object","oneOf":[{"$ref":"#/components/schemas/IdentityFieldDropdownConfigurationDto"}],"nullable":true},"required":{"type":"boolean","description":"This field will be always `false` in R1","readOnly":true,"example":true}},"required":["id","uniqueName","name","kind","serviceSource","serviceDetails","configuration","required"]},"PublicUpdateIdentityCustomFieldRequestDto":{"type":"object","properties":{"attributeName":{"type":"string","example":"foo bar"},"attributeCode":{"type":"string","example":"employee_id","description":"Unique identifier for the custom field. Must contain only lowercase letters, numbers, and underscores. Cannot be changed to a value that already exists in the organization."}}},"PublicGetIggreRequestWithRequestIdDto":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["requestId"]},"AggreRequestStatus":{"type":"string","enum":["pending","processing","finished","finishedWithErrors","failed"]},"PublicGetIggreRequestWithWorkflowRunIdAndStatusDto":{"type":"object","properties":{"limit":{"type":"number","example":50,"maximum":200,"description":"Limit the number of results returned. Maximum 200."},"cursor":{"type":"string","description":"Cursor to paginate through results."},"workflowRunId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"status":{"example":"pending","allOf":[{"$ref":"#/components/schemas/AggreRequestStatus"}]}},"required":["workflowRunId"]},"AggreRequestSuperType":{"type":"string","enum":["fetch","provision","deprovision","file-aggregation","remove"]},"PublicGetIggreRequestWithPeopleIdAndSuperTypeDto":{"type":"object","properties":{"limit":{"type":"number","example":50,"maximum":200,"description":"Limit the number of results returned. Maximum 200."},"cursor":{"type":"string","description":"Cursor to paginate through results."},"peopleId":{"type":"number"},"superType":{"example":"deprovision","allOf":[{"$ref":"#/components/schemas/AggreRequestSuperType"}]}},"required":["peopleId","superType"]},"PublicIggreRequestDto":{"type":"object","properties":{"requestId":{"type":"string","readOnly":true,"format":"uuid","example":"0da0bb7e-fe60-4b07-8bd1-f5c583ac84f6"},"status":{"readOnly":true,"example":"pending","allOf":[{"$ref":"#/components/schemas/AggreRequestStatus"}]},"rawMessage":{"type":"string","nullable":true,"readOnly":true,"example":"Email a@b.com belongs to Account ax-ax-ax-ax"},"message":{"type":"string","nullable":true,"readOnly":true,"example":"An account with this email already exists"},"data":{"type":"object","additionalProperties":true}},"required":["requestId","status","rawMessage","message","data"]},"PublicGetIggreRequestsResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicIggreRequestDto"}},"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]}},"required":["items","meta"]},"PublicDeleteAccountRequestDto":{"type":"object","properties":{"type":{"type":"string","enum":["delete","deactivate"]},"id":{"type":"string"},"workflowRunId":{"type":"string","format":"uuid"},"dataTransfer":{"type":"object"}},"required":["type","id"]},"PublicDeleteAccountBulkRequestDto":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/PublicDeleteAccountRequestDto"}},"required":["account"]},"AuditLogFilterableActorType":{"type":"string","enum":["user","system","api"]},"AuditLogCategory":{"type":"string","enum":["Alerts","Authentication","Automations","Contracts","CustomServices","Devices","Directory","EventLogs","Files","Notifications","Organizations","Services","Settings","Spends","Structures","Users","Workflows","WorkflowServiceConfigurations","Surveys"]},"PublicGetAuditLogsCountResponseDto":{"type":"object","properties":{"count":{"type":"number","description":"The total number of audit logs","example":100}},"required":["count"]},"EmailAttachment":{"type":"object","properties":{"fileName":{"type":"string","readOnly":true,"example":"body.pdf"},"fileType":{"type":"string","readOnly":true,"example":"application/pdf"},"s3Path":{"type":"string","readOnly":true,"example":"69576014/2024-04-19/d9j1sifi5ggghc2rkjruqpnoqorobvfr2hqedm01/body.pdf"}},"required":["fileName","fileType","s3Path"]},"PublicBillEmailDto":{"type":"object","properties":{"emailId":{"type":"string","readOnly":true,"example":"xxxxx"},"receivedAt":{"type":"string","readOnly":true,"example":"2022-08-31T07:11:20.000Z"},"toAddress":{"type":"string","readOnly":true,"example":"customer-email@gmail.com"},"senderAddress":{"type":"string","readOnly":true,"example":"noreply@github.com"},"fromAddress":{"type":"string","readOnly":true,"example":"noreply@github.com"},"fromName":{"type":"string","readOnly":true,"example":"GitHub"},"forwardedToAddress":{"type":"string","readOnly":true,"example":"mfi-123@forward.i.moneyforward.com"},"subject":{"type":"string","readOnly":true,"example":"Your payment from GitHub"},"serviceName":{"type":"string","readOnly":true,"example":"GitHub"},"serviceUniqueName":{"type":"string","readOnly":true,"example":"github"},"attachments":{"readOnly":true,"example":[{"fileName":"receipt.pdf","fileType":"application/pdf","s3Path":"69576014/2024-04-19/d9j1sifi5ggghc2rkjruqpnoqorobvfr2hqedm01/receipt.pdf"}],"type":"array","items":{"$ref":"#/components/schemas/EmailAttachment"}}},"required":["emailId","receivedAt","toAddress","senderAddress","fromAddress","fromName","forwardedToAddress","subject","serviceName","serviceUniqueName","attachments"]},"PublicGetBillEmailsResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicBillEmailDto"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta"}},"required":["items","meta"]},"PublicGetAttachmentDownloadUrlResponseDto":{"type":"object","properties":{"url":{"type":"string","readOnly":true,"example":"https://s3.amazonaws.com/bucket/path/to/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=60&..."},"expiresIn":{"type":"number","readOnly":true,"example":60}},"required":["url","expiresIn"]},"PublicUpdateDeviceMetaRequestDto":{"type":"object","properties":{"status":{"example":"active","description":"The status of the device. **If `IN_STOCK` status is set, the device will be unassigned and the assignment start/end date will be cleared. If `DECOMMISSIONED` status is set, the assignment dates will be cleared but the last assigned user will be preserved for audit purposes.**","allOf":[{"$ref":"#/components/schemas/DeviceStatus"}]},"peopleId":{"type":"number","example":123,"nullable":true,"description":"The people ID to assign the device to. If `null`, the device will be unassigned. **Device that has `IN_STOCK` status can't be assigned to a person. For `DECOMMISSIONED` devices, the last assigned user is preserved for audit purposes.**"},"assignmentStartDate":{"type":"string","format":"date","example":"2021-01-01","nullable":true,"description":"The date the device is assigned to the person. **Device that has `IN_STOCK` or `DECOMMISSIONED` can't have assignment start date**"},"assignmentEndDate":{"type":"string","format":"date","example":"2021-01-02","nullable":true,"description":"The date the device assignment ends. **Device that has `IN_STOCK` or `DECOMMISSIONED` can't have assignment end date**"},"location1":{"type":"string","example":"location1","description":"Primary location information for the device"},"location2":{"type":"string","example":"location2","description":"Secondary location information for the device"},"comment":{"type":"string","example":"Assigned to new employee","nullable":true,"description":"Comment or reason for the assignment/status change"}}},"PublicCreateDeviceHistoryChangesDto":{"type":"object","properties":{"status":{"example":"active","allOf":[{"$ref":"#/components/schemas/DeviceStatus"}]},"peopleId":{"type":"number","example":1,"nullable":true,"description":"The people ID of the person the device is assigned to. **peopleId must not be present if status is in_stock or decommissioned**"},"location1":{"type":"string","example":"location1","nullable":true},"location2":{"type":"string","example":"location2","nullable":true},"assignmentStartDate":{"type":"string","format":"date","example":"2021-01-01","description":"The assignment start date of the device. **assignmentStartDate must not be present if status is in_stock or decommissioned**","nullable":true},"assignmentEndDate":{"type":"string","format":"date","example":"2021-01-02","nullable":true,"description":"The assignment end date of the device. **assignmentEndDate must not be present if status is in_stock or decommissioned. Assignment end date must be after assignment start date**"}},"required":["status"]},"PublicCreateDeviceHistoryEntryDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","example":"2021-01-01T00:00:00.000Z"},"changes":{"$ref":"#/components/schemas/PublicCreateDeviceHistoryChangesDto"},"comment":{"type":"string","example":"Status change reason","nullable":true}},"required":["createdAt","changes"]},"PublicUpdateDeviceHistoryChangesDto":{"type":"object","properties":{"peopleId":{"type":"number","example":1,"nullable":true,"description":"The people ID of the person the device is assigned to. **peopleId must not be present if status is in_stock or decommissioned**"},"status":{"example":"active","allOf":[{"$ref":"#/components/schemas/DeviceStatus"}]},"location1":{"type":"string","example":"location1","nullable":true},"location2":{"type":"string","example":"location2","nullable":true},"assignmentStartDate":{"type":"string","format":"date","example":"2021-01-01","description":"The assignment start date of the device. **assignmentStartDate must not be present if status is in_stock or decommissioned**","nullable":true},"assignmentEndDate":{"type":"string","format":"date","example":"2021-01-02","nullable":true,"description":"The assignment end date of the device. **assignmentEndDate must not be present if status is in_stock or decommissioned. Assignment end date must be after assignment start date**"}}},"PublicUpdateDeviceHistoryEntryDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","example":"2021-01-01T00:00:00.000Z","nullable":false},"changes":{"$ref":"#/components/schemas/PublicUpdateDeviceHistoryChangesDto"},"comment":{"type":"string","example":"Status change reason","nullable":true}},"required":["changes"]},"PublicDeleteDeviceHistoriesBulkRequestDto":{"type":"object","properties":{"deviceHistoryIds":{"example":[1,2,3],"description":"Array of device history entry IDs to delete. Maximum 50 IDs per request.","type":"array","items":{"type":"number"}}},"required":["deviceHistoryIds"]},"PublicDeleteDeviceHistoryEntriesResponseDto":{"type":"object","properties":{"deletedDeviceHistoryEntries":{"description":"List of deleted device history entries","type":"array","items":{"$ref":"#/components/schemas/PublicGetDeviceHistoryResponseDto"}}},"required":["deletedDeviceHistoryEntries"]},"PublicDeviceHistoryDto":{"type":"object","properties":{"id":{"type":"number","example":123},"deviceId":{"type":"number","example":321},"createdAt":{"type":"string","format":"date-time","example":"2017-07-21T17:32:28Z"},"changes":{"$ref":"#/components/schemas/DeviceHistoryChangesDto"},"comment":{"type":"string","example":"Assigned to new employee","nullable":true}},"required":["id","deviceId","createdAt","changes","comment"]},"PublicGetDeviceHistoriesListResponseDto":{"type":"object","properties":{"items":{"description":"List of device history entries","type":"array","items":{"$ref":"#/components/schemas/PublicDeviceHistoryDto"}}},"required":["items"]},"PublicGetEventLogsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]}},"required":["meta"]},"PublicEventLogSummaryByServiceDto":{"type":"object","properties":{"serviceName":{"type":"string","example":"マネーフォワード クラウド会計"},"eventCount":{"type":"number","example":100},"domainUrl":{"type":"string","example":"https://example.com","description":"The domain URL of the event log. Only available when skipCache is true."},"numberOfUsers":{"type":"number","example":5}},"required":["serviceName","eventCount","domainUrl","numberOfUsers"]},"OnlyNextCursorMeta":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"readOnly":true,"example":"F3UdkoSbpBNrjwP93AX2HQ"}},"required":["nextCursor"]},"PublicGetEventLogSummaryByServiceResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicEventLogSummaryByServiceDto"}},"meta":{"$ref":"#/components/schemas/OnlyNextCursorMeta"}},"required":["items","meta"]},"PublicEventLogSummaryByServiceBase":{"type":"object","properties":{"serviceName":{"type":"string","example":"マネーフォワード クラウド会計"},"eventCount":{"type":"number","example":100},"domainUrl":{"type":"string","example":"https://example.com","description":"The domain URL of the event log. Only available when skipCache is true."}},"required":["serviceName","eventCount","domainUrl"]},"PublicEventLogSummaryByUserDto":{"type":"object","properties":{"userEmail":{"type":"string","example":"test@example.com"},"summariesByService":{"type":"array","items":{"$ref":"#/components/schemas/PublicEventLogSummaryByServiceBase"}}},"required":["userEmail","summariesByService"]},"PublicGetEventLogSummaryByUserResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicEventLogSummaryByUserDto"}},"meta":{"$ref":"#/components/schemas/OnlyNextCursorMeta"}},"required":["items","meta"]},"IdentitySourceOfTruthSource":{"type":"string","enum":["workspace","admina"]},"SourceOfTruthDto":{"type":"object","properties":{"workspaceId":{"type":"number","readOnly":true,"example":1},"source":{"readOnly":true,"example":"workspace","allOf":[{"$ref":"#/components/schemas/IdentitySourceOfTruthSource"}]}},"required":["workspaceId","source"]},"PublicSingleIdentityPresetFieldConfigurationDto":{"type":"object","properties":{"uniqueName":{"type":"string","readOnly":true,"example":"asset_number"},"hidden":{"type":"boolean","readOnly":true,"example":false},"editable":{"type":"boolean","readOnly":true,"example":false},"sourceOfTruth":{"readOnly":true,"example":"asset_number","allOf":[{"$ref":"#/components/schemas/SourceOfTruthDto"}]}},"required":["uniqueName","hidden","editable","sourceOfTruth"]},"PublicGetSingleIdentityFieldConfigurationResponseDto":{"type":"object","properties":{"presetFields":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicSingleIdentityPresetFieldConfigurationDto"}}},"required":["presetFields"]},"PublicContractResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Monthly Contract"},"serviceId":{"type":"number","readOnly":true,"example":123},"serviceName":{"type":"string","readOnly":true,"example":"GitHub"},"workspaceId":{"type":"number","nullable":true,"readOnly":true,"example":456},"workspaceName":{"type":"string","nullable":true,"readOnly":true,"example":"Production Workspace"},"dueDate":{"format":"date-time","type":"string","readOnly":true,"example":"2023-01-01T00:00:00.000Z"},"nextDueDate":{"format":"date-time","type":"string","nullable":true,"readOnly":true,"example":"2023-02-01T00:00:00.000Z"},"note":{"type":"string","nullable":true,"readOnly":true,"example":"Contract notes"}},"required":["id","name","serviceId","serviceName","workspaceId","workspaceName","dueDate","nextDueDate","note"]},"PublicGetContractsResponseDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicContractResponseDto"}},"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CursorPaginationMeta"}]}},"required":["items","meta"]},"ContractRepeatUnit":{"type":"string","enum":["months","years"]},"PublicCreateContractRequestDto":{"type":"object","properties":{"name":{"type":"string","example":"Monthly Contract"},"workspaceId":{"type":"number","example":12345678,"nullable":true},"dueDate":{"type":"string","example":"2023-01-01T00:00:00.000Z"},"repeatUnit":{"example":"months","allOf":[{"$ref":"#/components/schemas/ContractRepeatUnit"}]},"repeatValue":{"type":"number","example":1},"peopleIds":{"example":[1,2,3],"type":"array","items":{"type":"string"}},"note":{"type":"string","example":"Contract notes"}},"required":["name","dueDate","repeatUnit","repeatValue"]},"PublicUpdateContractRequestDto":{"type":"object","properties":{"name":{"type":"string","example":"Updated Monthly Contract"},"workspaceId":{"type":"number","example":12345678,"nullable":true},"dueDate":{"type":"string","example":"2023-02-01T00:00:00.000Z"},"repeatUnit":{"example":"months","allOf":[{"$ref":"#/components/schemas/ContractRepeatUnit"}]},"repeatValue":{"type":"number","example":2},"peopleIds":{"example":[1,2,3],"type":"array","items":{"type":"string"}},"note":{"type":"string","example":"Updated contract notes"}}},"PublicAlertServiceInfoDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Slack"},"uniqueName":{"type":"string","nullable":true,"readOnly":true,"example":"slack"}},"required":["id","name","uniqueName"]},"PublicAlertWorkspaceInfoDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"workspaceName":{"type":"string","nullable":true,"readOnly":true,"example":"workspace-name"}},"required":["id","workspaceName"]},"PublicAlertUserInfoDto":{"type":"object","properties":{"peopleAccountId":{"type":"string","readOnly":true,"example":"157#user@example.com"},"accountKey":{"type":"string","nullable":true,"readOnly":true,"example":"user@example.com"},"displayName":{"type":"string","nullable":true,"readOnly":true,"example":"John Doe"},"primaryEmail":{"type":"string","nullable":true,"readOnly":true,"example":"user@example.com"}},"required":["peopleAccountId","accountKey","displayName","primaryEmail"]},"PublicAlertResponseDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"type":{"type":"string","readOnly":true,"enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"],"example":"retired_account"},"level":{"type":"string","readOnly":true,"enum":["warning","caution"],"example":"warning"},"muted":{"type":"boolean","readOnly":true},"service":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PublicAlertServiceInfoDto"}]},"workspace":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PublicAlertWorkspaceInfoDto"}]},"user":{"nullable":true,"readOnly":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PublicAlertUserInfoDto"}]},"fileId":{"type":"string","nullable":true,"readOnly":true,"example":"file-id-123"},"lastCheckedAt":{"type":"string","readOnly":true,"example":"2024-01-01T00:00:00.000Z"},"muteUntil":{"type":"string","readOnly":true,"example":"2024-01-01T00:00:00.000Z"},"createdAt":{"type":"string","readOnly":true,"example":"2024-01-01T00:00:00.000Z"},"updatedAt":{"type":"string","readOnly":true,"example":"2024-01-01T00:00:00.000Z"}},"required":["id","type","level","muted","service","workspace","user","fileId","lastCheckedAt","muteUntil","createdAt","updatedAt"]},"PublicGetAlertsResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OnlyNextCursorMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicAlertResponseDto"}}},"required":["meta","items"]},"PublicAlertMuteServiceInfoDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"name":{"type":"string","readOnly":true,"example":"Slack"},"uniqueName":{"type":"string","nullable":true,"readOnly":true,"example":"slack"}},"required":["id","name","uniqueName"]},"PublicAlertMuteDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"example":1},"service":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PublicAlertMuteServiceInfoDto"}]},"alertType":{"type":"string","readOnly":true,"enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"],"example":"retired_account"},"reason":{"type":"string","nullable":true,"readOnly":true,"example":"Service being decommissioned"},"createdAt":{"type":"string","readOnly":true,"example":"2024-01-01T00:00:00.000Z"},"updatedAt":{"type":"string","readOnly":true,"example":"2024-01-01T00:00:00.000Z"}},"required":["id","service","alertType","reason","createdAt","updatedAt"]},"PublicGetAlertMutesResponseDto":{"type":"object","properties":{"meta":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OnlyNextCursorMeta"}]},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PublicAlertMuteDto"}}},"required":["meta","items"]},"PublicMuteServiceAlertsRequestDto":{"type":"object","properties":{"serviceIds":{"description":"Service IDs for which to mute alerts (max 50)","example":[1,2,3],"type":"array","items":{"type":"number"}},"alertType":{"type":"string","description":"Optional: Specific alert type to mute (if not provided, mutes all alert types for the services)","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"],"example":"retired_account"},"reason":{"type":"string","description":"Optional reason for muting. Alert type mutes are permanent until explicitly unmuted.","example":"Service being decommissioned"}},"required":["serviceIds"]},"PublicUnmuteServiceAlertsRequestDto":{"type":"object","properties":{"serviceIds":{"description":"Service IDs for which to unmute alerts (max 50)","example":[1,2,3],"type":"array","items":{"type":"number"}},"alertType":{"type":"string","description":"Optional: Specific alert type to unmute (if not provided, unmutes all alert types for the services)","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"],"example":"retired_account"}},"required":["serviceIds"]},"PublicMuteAccountAlertsRequestDto":{"type":"object","properties":{"accountIds":{"description":"Account IDs (peopleAccountIds) to mute alerts for","example":["157#user@example.com","158#another@example.com"],"type":"array","items":{"type":"string"}},"alertType":{"type":"string","description":"Alert type to mute","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"],"example":"retired_account"},"until":{"type":"string","description":"Optional: Timestamp until when the alert should be muted (ISO 8601 format). If not provided, mutes indefinitely.","example":"2024-12-31T23:59:59.000Z"},"muteOtherAccounts":{"type":"boolean","description":"Whether to also mute other accounts of the same people","default":false}},"required":["accountIds","alertType"]},"PublicUnmuteAccountAlertsRequestDto":{"type":"object","properties":{"accountIds":{"description":"Account IDs (peopleAccountIds) to unmute alerts for","example":["157#user@example.com","158#another@example.com"],"type":"array","items":{"type":"string"}},"alertType":{"type":"string","description":"Alert type to unmute","enum":["retired_account","inactive_account","on_leave_account","unknown_account","public_files"],"example":"retired_account"},"unmuteOtherAccounts":{"type":"boolean","description":"Whether to also unmute other accounts of the same people","default":false}},"required":["accountIds","alertType"]},"PublicMuteFileAlertsRequestDto":{"type":"object","properties":{"fileIds":{"description":"File IDs to mute public file alerts for","example":["file-id-1","file-id-2"],"type":"array","items":{"type":"string"}},"until":{"type":"string","description":"Optional: Timestamp until when the alert should be muted (ISO 8601 format). If not provided, mutes indefinitely.","example":"2024-12-31T23:59:59.000Z"}},"required":["fileIds"]},"PublicUnmuteFileAlertsRequestDto":{"type":"object","properties":{"fileIds":{"description":"File IDs to unmute public file alerts for","example":["file-id-1","file-id-2"],"type":"array","items":{"type":"string"}}},"required":["fileIds"]}}}}