Skip to main content

CheckAccess executes an Access Request for an User

The resulting evaluation is stored in SourceHub. It's used to generate a cryptographic proof that the given Access Request was valid at a particular block height.

Request Body — REQUIRED
creator string
policy_id string
creation_time date-time
access_request object
operations object[]
object object

Object represents an entity which must be access controlled within a Policy.

resource string
id string
permission permission required to perform operation
actor object

Actor represents an entity which makes access requests to a Policy.

id string
Responses
200

A successful response.

Schema — OPTIONAL
decision object — OPTIONAL
id string — OPTIONAL
policy_id used as part of id generation — OPTIONAL
creator used as part of id generation — OPTIONAL
creator_acc_sequence uint64 — OPTIONAL
operations object[] — OPTIONAL
object object — OPTIONAL

Object represents an entity which must be access controlled within a Policy.

resource string — OPTIONAL
id string — OPTIONAL
permission permission required to perform operation — OPTIONAL
actor_did used as part of id generation — OPTIONAL
actor used as part of id generation — OPTIONAL
params object — OPTIONAL
decision_expiration_delta uint64 — OPTIONAL
proof_expiration_delta uint64 — OPTIONAL
ticket_expiration_delta uint64 — OPTIONAL
creation_time date-time — OPTIONAL
issued_height uint64 — OPTIONAL
default

An unexpected error response.

Schema — OPTIONAL
code int32 — OPTIONAL
message string — OPTIONAL
details object[] — OPTIONAL