Skip to main content

Access

Every privilege your credential holds in a workspace, and where it holds it.

Access object​

Every privilege a credential holds in one workspace, each with the organizations where it applies.

privilegesarray of AccessPrivilege

Every privilege the caller holds here, with where it holds it.

credentialAccessCredential

The credential the caller presented.

Read your access in a workspace​

GET/workspaces/{workspace_id}/access
Preview

Returns every privilege your credential holds in the workspace, and where. For an API token it is the token's own access, inside its scopes and organization limits, never the whole access of the person behind it.

curl -X GET \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/access" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
workspace:read
Privilege
workspace.read

Needs workspace.read. Any grant in the workspace carries workspace.read.

Behavior

Retry
Safe to send again

Path parameters

workspace_iduuidrequired

The workspace's id.

Query parameters

fieldsarray of string

Comma-separated top-level fields of each object to return instead of the default set.

Sent by default: privilegescredential

Response 200

accessAccessrequired

The access.

messagestringrequired

What the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.

Errors

StatusCodeWhenSend again?
400APP_API_ERR_BAD_PARAMETERSA query parameter it does not take, one given twice, or fields naming a field it does not have.No
403APP_API_ERR_NO_PRIVILEGEtoken_scopeno_privilegeYou do not hold workspace.read. The same refusal comes when the path names a workspace other than the token's own.No

Plus the errors every call can return.