Parcel (0.1.0)

Download OpenAPI specification:Download

Secure data sharing

Authentication

AccessToken

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT-format access token. Must include `kid` if the signer is not the first of the identity/app's verifiers. "

identity

Operations on your Parcel identity

Creates a new identity.

Request Body schema: application/json
required
Array of objects (IdentityTokenVerifier)

Responses

Request samples

Content type
application/json
{
  • "tokenVerifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "IPoxXkdvFsrqzDdU7h3QqSs",
  • "createdAt": "2020-12-09T09:51:41.000Z",
  • "tokenVerifiers": [
    ]
}

Returns the identity of the authorized requester.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Returns the specified identity.

Authorizations:
path Parameters
identityId
required
string (IdentityId)
Example: IPoxXkdvFsrqzDdU7h3QqSs

The unique identifier of the identity.

Responses

Response samples

Content type
application/json
{
  • "id": "IPoxXkdvFsrqzDdU7h3QqSs",
  • "createdAt": "2020-12-09T09:51:41.000Z",
  • "tokenVerifiers": [
    ]
}

Updates the requested identity.

Authorizations:
path Parameters
identityId
required
string (IdentityId)
Example: IPoxXkdvFsrqzDdU7h3QqSs

The unique identifier of the identity.

Request Body schema: application/json

The identity's new fields.

required
Array of objects (IdentityTokenVerifier)

Responses

Request samples

Content type
application/json
{
  • "id": "IPoxXkdvFsrqzDdU7h3QqSs",
  • "createdAt": "2020-12-09T09:51:41.000Z",
  • "tokenVerifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "IPoxXkdvFsrqzDdU7h3QqSs",
  • "createdAt": "2020-12-09T09:51:41.000Z",
  • "tokenVerifiers": [
    ]
}

Deletes the specified identity. An identity can only be deleted by itself.

Authorizations:
path Parameters
identityId
required
string (IdentityId)
Example: IPoxXkdvFsrqzDdU7h3QqSs

The unique identifier of the identity.

Responses