HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Get an overview of who has access to what

get
https://example.com/access

Given a subject, give an overview of all his/her/its resources and who has access.

This endpoint may only be used by authorization agents.

If the token contains the authorization agent as the sub claim and the authorization agent is whitelisted by the server, you have access to any subject who/that has this authorization agent in his/her/its WebID profile document.

If the authorization agent as the azp claim and the authorization agent is whitelisted by the server, you have access to the subject listed in the sub claim as long as this subject has this authorization agent in his/her/its WebID profile document.

Query Params
string
required

The subject for which you want an overview of what access rules are defined.

Headers
string

A Solid token granted to the authorisation agent of the data subject. More specifically, the data subject's WebID contains a triple referencing the URI of his/her authorisation agent. This URI must be in either the sub or azp claim of the token.

string

The DPoP proof of this token.

string

If provided, this string will be set as the value of the X-Request-ID response header.

string

If provided, this string will be set as the value of the X-Correlation-ID response header.

string

If provided, this value will be used in the reponse to enable cross origin resource sharing.

Responses

tenant_not_found
conditional_http_requests_not_yet_supported
x_correlation_id_invalid
x_request_id_invalid
subject_query_parameter_missing
subject_invalid_uri
authorization_agent_not_allowed_by_server
subject_authorization_agent_does_not_match
subject_parameter_does_not_match_subject_token

Updated about 2 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated about 2 years ago