Search…
Organizations
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.

List Organizations

Retrieve a list of organizations in the authorized scope.
curl
1
curl -i \
2
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
3
https://ident.provide.services/api/v1/organizations
4
HTTP/2 200
Copied!
Response JSON:
1
{
2
"id": "efef1044-4958-43bc-903b-28f2bb938037"
3
}
Copied!

Create Organization

Create a new organization.
curl
1
curl -v -XPOST \
2
-H 'content-type: application/json' \
3
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
4
https://ident.provide.services/api/v1/organizations --data-binary @- << EOF
5
{
6
"name":"organization name",
7
"description":"organization description"
8
}
9
EOF
10
Copied!
Response JSON:
1
{
2
"id": "4059f749-55ad-4c1c-975d-6c5040801079"
3
}
Copied!

Retrieve Organization Details

Retrieve details for an organization.
curl
1
curl -v \
2
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
3
https://ident.provide.services/api/v1/organizations/efef1044-4958-43bc-903b-28f2bb938037
4
Copied!
Response JSON:
1
{
2
"id": "efef1044-4958-43bc-903b-28f2bb938037"
3
}
Copied!

URL Parameters

Parameter
Description
id
id of the Organization

Update Organization

Update an organization.
curl
1
curl -v -XPUT \
2
-H 'content-type: application/json' \
3
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
4
https://ident.provide.services/api/v1/organizations/efef1044-4958-43bc-903b-28f2bb938037 --data-binary @- << EOF
5
{
6
"name":"organization name",
7
"description":"organization description"
8
}
9
EOF
Copied!

URL Parameters

Parameter
Description
id
id of the Organization

Delete Organization

Delete an organization.
curl
1
curl -XDELETE -i \
2
-H 'content-type: application/json' \
3
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
4
https://ident.provide.services/api/v1/organizations/efef1044-4958-43bc-903b-28f2bb938037 \
5
HTTP/2 204
Copied!
Last modified 4mo ago