Access

Explain effective grant access

Evaluates one route and target for any grant audience and returns additive capabilities, matching grants, and failed checks for every candidate.

get/v1/spaces/{spaceId}/grants/check

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/spaces/{spaceId}/grants/check
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

spaceIdstring required

Query parameters

pathstring

Request path to simulate, for example /admin.

target'live' | 'version' | 'branch'

Which deployment the visit lands on: the live channel, one version, or a branch.

targetIdstring

The version id or branch name named by target. Required for version and branch, and rejected for live.

audience'public' | 'team' | 'person' | 'link' | 'password' | 'machine' | 'external'

Who is knocking. Each audience needs its own identifying parameter below, and rejects the others.

personIdstring

The person to simulate. Required with audience=person.

linkIdstring

The share link to simulate. Required with audience=link.

passwordCredentialIdstring

The password credential to simulate. Required with audience=password.

machineIdstring

The machine credential to simulate. Required with audience=machine.

issuerstring

Identity connection issuer for the external identity to simulate. Required with audience=external.

subjectstring

Subject claim of the external identity to simulate. Required with audience=external.

verifiedEmail'true' | 'false'

Whether the simulated visitor's email counts as verified.

ipAddressstring

Hypothetical client IP. IP-constrained Grants remain unsupported and denied.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

No recorded changes to this operation across all 1 revision of this API.