For AI agents: visit https://docs.use.id/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides Recipes API Reference Changelog

API Reference

Home Guides Recipes API Reference Changelog

Cogni

/status
- Check if the service is running and on what versionget
/openapi
- Gets the OpenAPI specificationget
/health
- Retrieve health information for serviceget
/profile
- Get the profile document of the serverget
/
- Get the WebID of the serverget
/.well-known/jwks.json
- Retrieve the public keys of the serverget
/.well-known/openid-configuration
- OIDC Configurationget
/users/{url-encoded-webid-or-email}
- putput
/otp/validate
- Validate an OTPget
/oauth/authorize
- OAuth Authorizationget
/patch/decide
- Decide on a patch requestget
/oauth/client
- Client credentials - Legacypost
/passwordless/email/send
- Send a login email to a userpost

use.id Distri

/
- Check if the service is runningget
/openapi
- Gets the OpenAPI specificationget
/health
- Retrieve health information for serviceget
/resource
- Create a new piece of datapost
/resources
- Get a list of resources you have access toget
/{data-piece-id}'
- Get a specific piece of dataget
/access
- Get an overview of who has access to whatget
- Add or remove access from a set of resourcespatch
/types/{url-encoded-uri}
- putput
/subjects/{url-encoded-uri}
- putput

put

https://example.com/subjects/{url-encoded-uri}

Create a new subject or update an existing subject.

Path Params

url-encoded-uri

string

required

The URL encoded URI of the subject. e.g. https://use.id/john

Query Params

internal_identifier

string

An extra internal identifier to refer to an other service's account/subject.

Headers

Authorization

string

A Solid token containing a URI in the sub or azp claim that is allowed to be used as an authorization agent.

DPoP

string

The DPoP proof for the token.

X-Request-ID

string

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

X-Correlation-ID

string

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

Responses

`subject_uri_not_valid`
`request_id_too_long`
`correlation_id_too_long`

`conditional_http_requests_not_yet_supported`

Updated over 2 years ago

Did this page help you?

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

Updated over 2 years ago

Did this page help you?

200OK

400Bad Request Potential error codes: subject_uri_not_valid request_id_too_long correlation_id_too_long

401Unauthorized

403Forbidden

500Internal Server Error

501Not Implemented Potential error codes: conditional_http_requests_not_yet_supported

`subject_uri_not_valid`
`request_id_too_long`
`correlation_id_too_long`

`conditional_http_requests_not_yet_supported`