UPupguard
trust_exchange

Set Trust Center access

Changed on

Sets which resources a user or organization, identified by email address, can access across your Trust Centers. The resources resolved from the request are granted, and any currently-accessible resources not among them are revoked, so their access ends up matching the request. Access is reconciled for one scope only: if the user has both organization-level and personal access, this updates the organization-level access.

Use mode to choose the set:

all: every resource published to any of your Trust Centers.

trust_centers: every resource on the Trust Centers named by trust_center_uuids.

specific: exactly the documents and questionnaires listed. Empty lists revoke all of the user's or organization's current access, and a document or questionnaire that isn't published on any of your Trust Centers is rejected rather than silently ignored.

The all and trust_centers modes resolve resources at the time of the call. Resources added to a Trust Center later aren't granted automatically; call this endpoint again to include them. For those modes, duration_days or custom_end_date sets the expiry on every granted resource.

If the email does not yet belong to a user, they are invited with the requested access applied when they accept. If the email has access through multiple organizations, provide org_name and/or org_primary_hostname to disambiguate. Those filters can also name an organization the user belongs to but doesn't yet have access through, in which case access is created there.

Required API key permissions: TrustExchange and ReadWrite (select when creating API key in Account Settings)

post/trust_exchange/trust_center/access/set

Request

Query parameters

emailstring required

Email address of the user or organization representative whose access should be set.

org_namestring

Organization name to disambiguate when the user has access through multiple organizations, or to target one the user belongs to but has no access through yet.

org_primary_hostnamestring

Organization primary hostname to disambiguate when the user has access through multiple organizations, or to target one the user belongs to but has no access through yet.

Request body

custom_end_datestring date-time

For modes all and trust_centers: grant access until this time. Mutually exclusive with duration_days.

duration_daysinteger

For modes all and trust_centers: grant access for this many days. Mutually exclusive with custom_end_date.

mode'all' | 'trust_centers' | 'specific' required

How the desired access is expressed: all (every resource on all your Trust Centers), trust_centers (every resource on the named Trust Centers), or specific (the exact documents and questionnaires listed).

trust_center_uuidsstring[]

For mode trust_centers: the Trust Centers (by UUID) whose resources should be granted. Each must be a lowercase v4 UUID.

Example request

{
  "mode": "specific"
}

Response

No Content

Changes