API Reference
- Overview
- Organizations
- Invitations
- Policies
- Features
Wallets and Private Keys
- Wallets
- Signing
- Private Keys
- Private Key Tags
Users
- Users
- User Tags
- User Recovery
- User Auth
Credentials
- Authenticators
- API keys
- Sessions
Activities
- Activities
- Consensus
Get Policy
Get details about a Policy
POST
/
public
/
v1
/
query
/
get_policy
Copy
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_policy \
--header 'Content-Type: application/json' \
--header 'X-Stamp: <api-key>' \
--data '{
"organizationId": "<string>",
"policyId": "<string>"
}'
Copy
{
"policy": {
"policyId": "<string>",
"policyName": "<string>",
"effect": "EFFECT_ALLOW",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"notes": "<string>",
"consensus": "<string>",
"condition": "<string>"
}
}
Authorizations
Body
application/json
Unique identifier for a given Organization.
Unique identifier for a given Policy.
Response
200 - application/json
A successful response.
Unique identifier for a given Policy.
Human-readable name for a Policy.
Available options:
EFFECT_ALLOW
, EFFECT_DENY
Human-readable notes added by a User to describe a particular policy.
A consensus expression that evalutes to true or false.
A condition expression that evalutes to true or false.
Was this page helpful?
Copy
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_policy \
--header 'Content-Type: application/json' \
--header 'X-Stamp: <api-key>' \
--data '{
"organizationId": "<string>",
"policyId": "<string>"
}'
Copy
{
"policy": {
"policyId": "<string>",
"policyName": "<string>",
"effect": "EFFECT_ALLOW",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"notes": "<string>",
"consensus": "<string>",
"condition": "<string>"
}
}