Parcel (0.1.0)

Download OpenAPI specification:Download

Secure data sharing

Authentication

AccessToken

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: https://auth.oasislabs.com/oauth/authorize
Scopes:
  • parcel.public -

    Grants access to APIs that read only public data.

  • parcel.safe -

    Grants non-destructive access to APIs (e.g. create new resources like document uploads) and access to read private data when the token's actor (i.e. the app) can.

  • parcel.full -

    Grants access to APIs that read private data or write any data.

authorizationCode OAuth Flow
Authorization URL: https://auth.oasislabs.com/oauth/authorize
Token URL: https://auth.oasislabs.com/oauth/token
Refresh URL: https://auth.oasislabs.com/oauth/token
Scopes:
  • parcel.public -

    Grants access to APIs that read only public data.

  • parcel.safe -

    Grants non-destructive access to APIs (e.g. create new resources like document uploads) and access to read private data when the token's actor (i.e. the app) can.

  • parcel.full -

    Grants access to APIs that read private data or write any data.

clientCredentials OAuth Flow
Token URL: https://auth.oasislabs.com/oauth/token
Refresh URL: https://auth.oasislabs.com/oauth/token
Scopes:
  • parcel.public -

    Grants access to APIs that read only public data.

  • parcel.safe -

    Grants non-destructive access to APIs (e.g. create new resources like document uploads) and access to read private data when the token's actor (i.e. the app) can.

  • parcel.full -

    Grants access to APIs that read private data or write any data.

identity

Operations on your Parcel identity

Create a new identity.

Authorizations:
AccessToken (parcel.safe)
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": [
    ]
}

Return the identity of the authorized requester.

Authorizations:
AccessToken (parcel.public)

Responses

Response samples

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

Return the specified identity.

Authorizations:
AccessToken (parcel.public)
path Parameters
required
IdentityId (string) or AppId (string) (IdentityOrAppId)
Example: IPoxXkdvFsrqzDdU7h3QqSs

The unique identifier of an identity or app.

Responses