--- title: "Get Data Security Identity" method: POST path: "/data-security-identity/{id}/get-item" tags: ["Data Security Identity"] --- # Get Data Security Identity `POST /data-security-identity/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-security-identity/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Data Security Identity by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` DataSecurityIdentitySelectSchema: Select schema for DataSecurityIdentity. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `identityKey` boolean - `principal` boolean - `principalName` boolean - `principalType` boolean - `provider` boolean - `isExternal` boolean - `isPublic` boolean - `isUnused` boolean - `isSeenInTraces` boolean - `storeCount` boolean - `sensitiveStoreCount` boolean - `restrictedStoreCount` boolean - `highestSensitivity` boolean - `highestAccessLevel` boolean - `canChangeSensitiveData` boolean - `dataTypeIds` boolean - `estimatedRecords` boolean - `riskScore` boolean - `lastUsedAt` boolean - `firstSeenAt` boolean - `lastSeenAt` boolean ## Response `200` Successful response - object - `data` DataSecurityIdentity - `_id` string, uuid: ID of this object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `version` number: Object version - `projectId` string, uuid, required: ID of the project this identity belongs to. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `identityKey` string, required: The principal as its cloud writes it, which identifies the identity within its project. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `principal` string, required: Who or what it is, as its cloud names it: *, an account id, an ARN, an email, a service account. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `principalName` string: The identity's name, for people. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `principalType` string: What it is: Public, Account, Role, User, Group, Service Principal, Service Account or Service. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `provider` string: Where the identity lives: AWS, Azure, Google Cloud, or OneUptime for a service seen in traces. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `isExternal` boolean, required: The identity is outside the project's connected accounts. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `isPublic` boolean, required: The identity is anyone on the internet, or any AWS account. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `isUnused` boolean, required: The identity has not been used in 90 days, as far as its cloud can say. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `isSeenInTraces` boolean, required: OneUptime saw the identity use a store in traces. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `storeCount` number, required: How many data stores the identity can reach. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `sensitiveStoreCount` number, required: How many of them hold Confidential or Restricted data. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `restrictedStoreCount` number, required: How many of them hold Restricted data. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `highestSensitivity` 'Restricted' | 'Confidential' | 'Internal' | 'Public', required: How sensitive the most sensitive store it reaches is: Restricted, Confidential, Internal or Public. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `highestAccessLevel` string: The most it may do to any store it reaches: Read, Write or Admin. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `canChangeSensitiveData` boolean, required: It may write to, or control, a store holding Confidential or Restricted data. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `dataTypeIds` object: The data types found in the sensitive stores it reaches, by their ids. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `estimatedRecords` number: About how many records with sensitive data the stores it reaches hold, where scans could tell. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `riskScore` number, required: How much harm the identity could do with what it reaches, from 0 to 100. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `lastUsedAt` object: When the identity was last used, where OneUptime can tell. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `firstSeenAt` object: When the identity was first found reaching a store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] - `lastSeenAt` object: When the identity was last found reaching a store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Security Identity], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)