UPupguard
trust_exchange

Get Trust Center access for a user

Changed on

Returns Trust Center access information for a specific user identified by email address, including current access status and any pending access requests.

Note: Access applies across all of your Trust Centers, not to one in particular.

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

get/trust_exchange/trust_center/access/user

Request

Query parameters

emailstring required

Email address of the user to look up.

org_namestring

Organization name to disambiguate when the user has access through multiple organizations.

org_primary_hostnamestring

Organization primary hostname to disambiguate when the user has access through multiple organizations.

Response

Trust Center access detail for a specific user.

created_atstring date-time

The date the access was created. Null when there is no access.

emailstring

The email address that was looked up.

has_signed_ndaboolean

Whether the user or organization has a current signed NDA.

nda_exemptboolean

Whether the user or organization is exempt from NDA requirements.

nda_manually_approvedboolean

Whether the NDA was manually approved for this user or organization.

nda_pending_countersignboolean

Whether the user or organization has signed the NDA and it is awaiting countersignature.

org_namestring

The name of the organization with access. Empty when the access is personal to the user, or when there is no access.

org_primary_hostnamestring

The primary hostname of the organization with access. Empty when the access is personal to the user, or when there is no access.

org_representative_emailstring

The email of the user linked as a representative for the organization. Empty when the access is personal to the user, or when there is no access.

updated_atstring date-time

The date the access was last updated. Null when there is no access.

Example response

{
  "access_request": {
    "created_at": "2024-03-20T15:30:00Z",
    "id": 456,
    "message": "Please grant me access to your security documents.",
    "updated_at": "2024-03-20T15:30:00Z"
  },
  "created_at": "2024-03-20T15:30:00Z",
  "email": "jane@example.com",
  "has_signed_nda": true,
  "org_name": "Acme Corp",
  "org_primary_hostname": "acme.com",
  "org_representative_email": "bob@acme.com",
  "updated_at": "2024-03-20T15:30:00Z"
}

Changes