Direct Data Sharing (DDS) Credentials Management API Usage Notes

Example User Flow

  1. Request inital delta sharing token activation link
    • User requests delta sharing token metadata from DDS API via GET /dds-tokens
    • DDS API responds with delta sharing token metadata
      • Metadata for a single token are returned with status ACTIVE and a non-null activation link
  2. Obtain delta sharing credentials
    • User requests credentials from delta sharing server using activation link
    • Delta sharing server responds with credentials json (config.share), which contains a bearer token
  3. Access data (as required while credentials remain valid)
    • User requests shared data from delta sharing server using bearer token from the credentials json
    • Delta sharing server returns the requested data
  4. Rotate delta sharing token (at any time, as required)
    • User requests rotation of delta sharing token via POST /dds-tokens
      • The user sets a new, reduced time-to-live (TTL) of any old delta sharing tokens as part of the request
    • DDS API responds with metadata for both the new and old delta sharing tokens
      • The new token has status ACTIVE and a non-null activation link
      • The old token has status ROTATED
  5. Obtain new delta sharing credentials (as before)
    • User requests credentials from delta sharing server using activation link
    • Delta sharing server responds with credentials json (config.share), which contains a bearer token
  6. Access data (as required while credentials remain valid)
    • User requests shared data from delta sharing server using bearer token from the credentials json
    • Delta sharing server returns the requested data
  7. Revoke existing delta sharing tokens
    • [In case a new token is required when there are already two valid tokens]
    • User requests delta sharing token update via PATCH /dds-tokens
      • Use payload {"existing_token_expiry_time_in_seconds": 0}
    • DDS API responds with empty list of tokens
      • Indicates that all tokens have been revoked
  8. Request new token delta sharing activation link
    • User requests delta sharing token metadata from DDS API via POST /dds-tokens
    • In this case the value used for existing_token_expiry_time_in_seconds has no impact since there are no existing tokens.
    • DDS API responds with delta sharing token metadata
      • Metadata for a single token are returned with status ACTIVE and a non-null activation link
  9. Obtain delta sharing credentials (as before)
    • etc.
Contact Support