Skip to main content
GET
CheckVaultAccess

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id
string
required

Application owning the Edge.

id
string
required

Edge identifier.

Query Parameters

vault_boundary_id
string

Vault whose OpenSecret grant is checked.

Response

200 - application/json

EdgeServiceCheckVaultAccessResponse reports metadata, never secret values.

EdgeServiceCheckVaultAccessResponse reports metadata, never secret values.

granted
boolean

Whether the runtime currently holds the OpenSecret entitlement.

openSecretEntitlementId
string

Vault-wide entitlement to request through normal access policy.

reason
enum<string>

Explanation of the current grant state.

Available options:
EDGE_VAULT_ACCESS_REASON_UNSPECIFIED,
EDGE_VAULT_ACCESS_REASON_GRANTED,
EDGE_VAULT_ACCESS_REASON_NOT_GRANTED,
EDGE_VAULT_ACCESS_REASON_NO_RUNTIME_PRINCIPAL,
EDGE_VAULT_ACCESS_REASON_VAULT_NOT_FOUND
runtimeServicePrincipalId
string

Bound Edge runtime service principal, if available.