--- title: "Get self" method: GET path: "/api/v2/self" tags: ["Auth", "Community", "Enterprise"] --- # Get self `GET /api/v2/self` Get the currently authenticated requester details. For Community, this will only ever be valid for users. In Enterprise, this could be either a BloodHound user or a client (collector). ## Response `200` OK - ApiResponseAuthenticatedRequester - `data` union - ModelUser - `id` string, uuid — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `saml_provider_id` NullInt32 - `int32` integer - `valid` boolean — Valid is true if `int32` is not `null`. - `sso_provider_id` NullInt32 - `int32` integer - `valid` boolean — Valid is true if `int32` is not `null`. - `AuthSecret` ModelAuthSecret - `id` integer — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `digest_method` string - `expires_at` string, date-time - `totp_activated` boolean - `roles` ModelRole[] - `id` integer — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `name` string - `description` string - `permissions` ModelPermission[] - `id` integer — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `authority` string - `name` string - `first_name` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `last_name` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `email_address` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `principal_name` string - `last_login` string, date-time - `is_disabled` boolean - `eula_accepted` boolean - ModelClient - `id` string, uuid — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `name` string - `ip_address` string, ipv4 - `hostname` string, hostname - `configured_user` string - `last_checkin` string, date-time - `events` ModelClientSchedule[] - `id` integer — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `client_id` string, uuid - `rrule` string - `session_collection` boolean - `local_group_collection` boolean - `ad_structure_collection` boolean - `cert_services_collection` boolean - `ca_registry_collection` boolean - `dc_registry_collection` boolean - `all_trusted_domains` boolean - `next_scheduled_at` string, date-time - `ous` string[] - `domains` string[] - `token` ModelAuthToken - `id` string, uuid — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `user_id` NullUuid - `uuid` string, uuid - `valid` boolean — Valid is true if `uuid` is not `null`. - `name` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `key` string - `hmac_method` string - `last_access` string, date-time - `created_by` NullUuid - `uuid` string, uuid - `valid` boolean — Valid is true if `uuid` is not `null`. - `current_job_id` NullInt64 - `int64` integer - `valid` boolean — Valid is true if `int64` is not `null`. - `current_job` ModelClientScheduledJob - `id` integer — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `client_id` string, uuid - `client_name` string - `event_id` NullInt32 - `int32` integer - `valid` boolean — Valid is true if `int32` is not `null`. - `status` -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — This enum describes the current status of a Job. Values are: - `-1` Invalid - `0` Ready - `1` Running - `2` Complete - `3` Canceled - `4` Timed Out - `5` Failed - `6` Ingesting - `7` Analyzing - `8` Partially Complete - `statusMessage` string - `start_time` string, date-time - `end_time` string, date-time - `log_path` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `session_collection` boolean - `local_group_collection` boolean - `ad_structure_collection` boolean - `cert_services_collection` boolean - `ca_registry_collection` boolean - `dc_registry_collection` boolean - `all_trusted_domains` boolean - `domain_controller` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `event_title` string - `last_ingest` string, date-time - `ous` string[] - `domains` string[] - `domain_results` ModelDomainCollectionResult[] - `id` integer — This is the unique identifier for this object. - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` NullTime - `time` string, date-time — An RFC-3339 formatted string - `valid` boolean — Valid is true if `time` is not `null`. - `job_id` integer - `domain_name` string — Name of the domain that was enumerated - `success` boolean — A boolean value indicating whether the domain enumeration succeeded - `message` string — A status message for a domain enumeration result - `user_count` integer — A count of users enumerated - `group_count` integer — A count of groups enumerated - `computer_count` integer — A count of computers enumerated - `gpo_count` integer — A count of gpos enumerated - `ou_count` integer — A count of ous enumerated - `container_count` integer — A count of containers enumerated - `aiaca_count` integer — A count of aiacas enumerated - `rootca_count` integer — A count of rootcas enumerated - `enterpriseca_count` integer — A count of enterprisecas enumerated - `ntauthstore_count` integer — A count of ntauthstores enumerated - `certtemplate_count` integer — A count of certtemplates enumerated - `deleted_count` integer — A count of deleted objects enumerated - `completed_job_count` integer - `domain_controller` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `version` string - `user_sid` NullString - `string` string - `valid` boolean — Valid is true if `string` is not `null` - `type` 'sharphound' | 'azurehound' | 'openhound' — This enum describes the collector client type. ## Other responses - `429` — **Too Many Requests** The client has sent too many requests within a certain time window and tripped the rate limiting middleware. --- [API](https://skmtc.net/specterops/apis/bloodhound-api.md) · [All operations](https://skmtc.net/specterops/apis/bloodhound-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/specterops/bloodhound-api/revisions/b7bbf50b77e7/schema)