APINHI
Re-check an NHI source
Re-check the stored credentials against the provider and record the result.
POST
Re-check the stored credentials against the provider and record the result.
ApiKeyAuthheader
AuthorizationBearer <token>Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.
Required permission
manage_nhisource_id*stringFormat
uuidThe request has succeeded.
application/json- response
A connected directory. Credentials are never returned.
id*uuidFormat
uuidprovider*"microsoft_entra"A directory that owns non-human identities.
Value in
"microsoft_entra"name*stringLength
1 <= length <= 255external_id*stringThe provider's canonical ID for the directory. For Entra, the tenant ID.
status*NhiSourceStatusWhether the stored credentials last authenticated successfully.
Value in
"connected""error"last_checked_at?stringWhen the credentials were last checked; absent until the first check.
Format
date-timeconfig*Provider-specific config, discriminated on provider.
created_at*stringFormat
date-timeupdated_at*stringFormat
date-timecurl -X POST "https://example.com/nhi/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08/check"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "provider": "microsoft_entra", "name": "string", "external_id": "string", "status": "connected", "last_checked_at": "2019-08-24T14:15:22Z", "config": { "provider": "microsoft_entra", "tenant_id": "string", "client_id": "string", "has_client_secret": true }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}