query · Module: Data Network · Requires data:read
Arguments
Returns
AccessPolicy!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query AccessPolicy($id: ID!) {
accessPolicy(id: $id) {
id
object
livemode
created
updated
rules {
role
objects
fields
scope
deny
require_credentials
}
}
}
{
"id": "pol_1a2B3c"
}
{
"data": {
"accessPolicy": {
"id": "pol_1a2B3c",
"object": "access_policy",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"rules": [
{
"role": "example",
"objects": [
"example"
],
"fields": [
"example"
],
"scope": "example",
"deny": true,
"require_credentials": [
"example"
]
}
]
}
}
}
Retrieve a AccessPolicy
query AccessPolicy($id: ID!) {
accessPolicy(id: $id) {
id
object
livemode
created
updated
rules {
role
objects
fields
scope
deny
require_credentials
}
}
}
{
"id": "pol_1a2B3c"
}
{
"data": {
"accessPolicy": {
"id": "pol_1a2B3c",
"object": "access_policy",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"rules": [
{
"role": "example",
"objects": [
"example"
],
"fields": [
"example"
],
"scope": "example",
"deny": true,
"require_credentials": [
"example"
]
}
]
}
}
}
query · Module: Data Network · Requires data:read
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
AccessPolicy!
| Field | Type |
|---|---|
id | String! |
object | AccessPolicyObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
rules | [AccessPolicyRulesItem!]! |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query AccessPolicy($id: ID!) {
accessPolicy(id: $id) {
id
object
livemode
created
updated
rules {
role
objects
fields
scope
deny
require_credentials
}
}
}
{
"id": "pol_1a2B3c"
}
{
"data": {
"accessPolicy": {
"id": "pol_1a2B3c",
"object": "access_policy",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"rules": [
{
"role": "example",
"objects": [
"example"
],
"fields": [
"example"
],
"scope": "example",
"deny": true,
"require_credentials": [
"example"
]
}
]
}
}
}