An Organization
represents a legal entity that exists in the context of a registry. An instance of the Ident organization registry is persisted in the configured PostgreSQL database and may be backed by a registry which lives on an immutable public ledger (i.e., such as the Ethereum public blockchain). Attestations, decentralized identifiers (DIDs) and verifiable credentials (VCs) can be attached to an organization. The organizations API makes it easy to verify attestations as well as broadcast organization details for registration of newly-created and updated organizations in public registries.
Access to programmatically manage resources associated with an organization is provided via REST API, to which ACL-based authorization is managed using generic permissions.
The registering user of an Organization
is associated with the organization record for historical purposes and does not authorize any access to the organization.
Retrieve a list of organizations in the authorized scope.
curl -i \-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \https://ident.provide.services/api/v1/organizationsHTTP/2 200
Response JSON:
{"id": "efef1044-4958-43bc-903b-28f2bb938037"}
Create a new organization.
curl -XPOST -i \-H 'content-type: application/json' \-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \https://ident.provide.services/api/v1/organizations \-d '{}'HTTP/2 201
Response JSON:
{"id": "4059f749-55ad-4c1c-975d-6c5040801079"}
Retrieve details for an organization.
curl -i \-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \https://ident.provide.services/api/v1/organizations/efef1044-4958-43bc-903b-28f2bb938037HTTP/2 200
Response JSON:
{"id": "efef1044-4958-43bc-903b-28f2bb938037"}
Parameter | Description |
id | id of the |
Update an organization.
curl -XPUT -i \-H 'content-type: application/json' \-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \https://ident.provide.services/api/v1/organizations/efef1044-4958-43bc-903b-28f2bb938037 \-d '{}'HTTP/2 204
Parameter | Description |
id | id of the |
Delete an organization.
curl -XDELETE -i \-H 'content-type: application/json' \-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \https://ident.provide.services/api/v1/organizations/efef1044-4958-43bc-903b-28f2bb938037 \HTTP/2 204