TrustArc Clients API
The Clients API from TrustArc — 13 operation(s) for clients.
The Clients API from TrustArc — 13 operation(s) for clients.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/trustarc:trustarc-clients-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Guardian Clients API
description: Guardian Authentication
version: v1
servers:
- url: https://login.truste.com
description: Generated server url
tags:
- name: Clients
paths:
/api/v1/clients/{id}:
get:
tags:
- Clients
operationId: get_11
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
security:
- guardianAuth: []
summary: Get 11
x-summary-source: derived
put:
tags:
- Clients
operationId: update_10
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
security:
- guardianAuth: []
summary: Update 10
x-summary-source: derived
delete:
tags:
- Clients
operationId: delete_9
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
security:
- guardianAuth: []
summary: Delete 9
x-summary-source: derived
/api/v1/clients:
get:
tags:
- Clients
operationId: list_11
parameters:
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: size
in: query
required: false
schema:
type: integer
format: int32
default: 10
- name: order
in: query
required: false
schema:
type: string
default: ASC
enum:
- ASC
- DESC
- name: columnName
in: query
required: false
schema:
type: string
default: clientName
- name: showontopheader
in: query
required: false
schema:
type: boolean
- name: accountId
in: query
required: false
schema:
type: string
default: ''
- name: userId
in: query
required: false
schema:
type: string
default: ''
- name: name
in: query
required: false
schema:
type: string
default: ''
- name: usingUserRolesOrGroups
in: query
required: false
schema:
type: boolean
- name: usingUserGroups
in: query
required: false
schema:
type: boolean
- name: type
in: query
required: false
schema:
type: string
default: Internal
enum:
- Internal
- Customer
- name: modifiedStart
in: query
required: false
schema:
type: integer
format: int64
description: Timestamp in seconds since epoch
- name: modifiedEnd
in: query
required: false
schema:
type: integer
format: int64
description: Timestamp in seconds since epoch
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PageClientApplication'
security:
- guardianAuth: []
summary: List 11
x-summary-source: derived
post:
tags:
- Clients
operationId: create_11
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
security:
- guardianAuth: []
summary: Create 11
x-summary-source: derived
/api/v1/clients/{id}/roles:
get:
tags:
- Clients
operationId: getRoles
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientApplicationRole'
uniqueItems: true
security:
- guardianAuth: []
summary: Get roles
x-summary-source: derived
post:
tags:
- Clients
operationId: createRoles
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientApplicationRole'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientApplicationRole'
uniqueItems: true
security:
- guardianAuth: []
summary: Create roles
x-summary-source: derived
/api/v1/clients/{id}/key/reset:
post:
tags:
- Clients
operationId: resetKey
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ClientApplicationKey'
security:
- guardianAuth: []
summary: Reset key
x-summary-source: derived
/api/v1/clients/metrics/promote:
post:
tags:
- Clients
operationId: promote
responses:
'204':
description: No Content
security:
- guardianAuth: []
summary: Promote
x-summary-source: derived
/api/v1/clients/metrics:
get:
tags:
- Clients
operationId: list_24
parameters:
- name: clientId
in: query
required: false
schema:
type: string
default: ''
- name: apiId
in: query
required: false
schema:
type: string
default: ''
- name: startDate
in: query
required: false
schema:
type: integer
format: int64
description: Timestamp in seconds since epoch
- name: endDate
in: query
required: false
schema:
type: integer
format: int64
description: Timestamp in seconds since epoch
- name: valueAgo
in: query
required: false
schema:
type: integer
format: int64
default: 1
- name: unitAgo
in: query
required: false
schema:
type: string
default: Weeks
enum:
- NANOS
- MICROS
- MILLIS
- SECONDS
- MINUTES
- HOURS
- HALF_DAYS
- DAYS
- WEEKS
- MONTHS
- YEARS
- DECADES
- CENTURIES
- MILLENNIA
- ERAS
- FOREVER
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientApplicationMetric'
security:
- guardianAuth: []
summary: List 24
x-summary-source: derived
/api/v1/clients/metrics/raw:
get:
tags:
- Clients
operationId: listRaw
parameters:
- name: clientId
in: query
required: false
schema:
type: string
default: ''
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomerMeterDTO'
security:
- guardianAuth: []
summary: List raw
x-summary-source: derived
/api/v1/clients/metrics/histogram:
get:
tags:
- Clients
operationId: histogram
parameters:
- name: clientId
in: query
required: false
schema:
type: string
default: ''
- name: apiId
in: query
required: false
schema:
type: string
default: ''
- name: startDate
in: query
required: false
schema:
type: integer
format: int64
description: Timestamp in seconds since epoch
- name: endDate
in: query
required: false
schema:
type: integer
format: int64
description: Timestamp in seconds since epoch
- name: valueAgo
in: query
required: false
schema:
type: integer
format: int64
default: 1
- name: unitAgo
in: query
required: false
schema:
type: string
default: Weeks
enum:
- NANOS
- MICROS
- MILLIS
- SECONDS
- MINUTES
- HOURS
- HALF_DAYS
- DAYS
- WEEKS
- MONTHS
- YEARS
- DECADES
- CENTURIES
- MILLENNIA
- ERAS
- FOREVER
- name: buckets
in: query
required: false
schema:
type: integer
format: int64
default: 10
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientMetricHistogram'
security:
- guardianAuth: []
summary: Histogram
x-summary-source: derived
/api/v1/clients/legacyid/{id}:
get:
tags:
- Clients
operationId: getByLegacyId
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
security:
- guardianAuth: []
summary: Get by legacy id
x-summary-source: derived
/api/v1/clients/grant-types:
get:
tags:
- Clients
operationId: getSupportedGrantTypes
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties:
type: string
security:
- guardianAuth: []
summary: Get supported grant types
x-summary-source: derived
/api/v1/clients/clientid/{clientId}:
get:
tags:
- Clients
operationId: getByClientId
parameters:
- name: clientId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
security:
- guardianAuth: []
summary: Get by client id
x-summary-source: derived
/api/v1/clients/metrics/raw/clear:
delete:
tags:
- Clients
operationId: clearRaw
responses:
'204':
description: No Content
security:
- guardianAuth: []
summary: Clear raw
x-summary-source: derived
/api/v1/clients/metrics/raw/clear/{clientId}:
delete:
tags:
- Clients
operationId: reset
parameters:
- name: clientId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
security:
- guardianAuth: []
summary: Reset
x-summary-source: derived
components:
schemas:
ClientApplicationMetric:
properties:
id:
type: string
format: uuid
date:
type: string
format: date-time
count:
type: integer
format: int64
applicationId:
type: string
apiId:
type: string
format: uuid
InternalClientApplication:
allOf:
- $ref: '#/components/schemas/ClientApplication'
- type: object
properties:
siteUri:
type: string
logoUri:
type: string
helpUri:
type: string
redirectPriority:
type: integer
format: int32
showOnTopheader:
type: boolean
required:
- clientId
CustomerClientApplication:
allOf:
- $ref: '#/components/schemas/ClientApplication'
- type: object
properties:
requestLimit:
type: integer
format: int64
required:
- clientId
ClientMetricHistogram:
properties:
clientId:
type: string
buckets:
type: array
items:
$ref: '#/components/schemas/ApiMetricHistogram'
dateTimes:
type: array
items:
type: string
format: date-time
CustomerMeterDTO:
properties:
clientId:
type: string
count:
type: integer
format: int64
apiList:
type: array
items:
$ref: '#/components/schemas/APIMeterDTO'
HistogramData:
properties:
sumFreq:
type: integer
format: int64
dateTime:
type: string
format: date-time
ClientApplication:
discriminator:
propertyName: type
properties:
id:
type: string
createdDate:
type: string
format: date-time
modifiedDate:
type: string
format: date-time
clientId:
type: string
maxLength: 2147483647
minLength: 1
clientSecret:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
writeOnly: true
clientName:
type: string
resourceIds:
type: array
items:
type: string
uniqueItems: true
scopes:
type: string
grantTypes:
type: string
authorities:
type: array
items:
$ref: '#/components/schemas/GrantedAuthority'
redirectUris:
type: string
autoApproveScopes:
type: string
allowedAudiences:
type: string
legacyIdentifier:
type: string
enabled:
type: boolean
requiresLicense:
type: boolean
accessTokenValiditySeconds:
type: integer
format: int32
refreshTokenValiditySeconds:
type: integer
format: int32
roles:
type: array
items:
$ref: '#/components/schemas/ClientApplicationRole'
uniqueItems: true
type:
type: string
enum:
- Internal
- Customer
accountId:
type: string
usingUserGroups:
type: boolean
delegateUserId:
type: string
usingUserRoles:
type: boolean
usingUserRolesOrGroups:
type: boolean
usingAccountRegistration:
type: boolean
usingLicense:
type: boolean
modifiedById:
type: string
required:
- clientId
SortObject:
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
PageableObject:
properties:
paged:
type: boolean
pageNumber:
type: integer
format: int32
pageSize:
type: integer
format: int32
offset:
type: integer
format: int64
sort:
$ref: '#/components/schemas/SortObject'
unpaged:
type: boolean
ApiMetricHistogram:
properties:
metricApi:
$ref: '#/components/schemas/MetricApi'
histogram:
type: array
items:
$ref: '#/components/schemas/HistogramData'
MetricApi:
properties:
id:
type: string
format: uuid
method:
type: string
status:
type: integer
format: int32
path:
type: string
ClientApplicationRole:
properties:
id:
type: string
identifier:
type: string
name:
type: string
description:
type: string
permissions:
type: string
PageClientApplication:
properties:
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/PageableObject'
size:
type: integer
format: int32
content:
type: array
items:
oneOf:
- $ref: '#/components/schemas/ClientApplication'
- $ref: '#/components/schemas/CustomerClientApplication'
- $ref: '#/components/schemas/InternalClientApplication'
number:
type: integer
format: int32
sort:
$ref: '#/components/schemas/SortObject'
first:
type: boolean
last:
type: boolean
numberOfElements:
type: integer
format: int32
empty:
type: boolean
APIMeterDTO:
properties:
api:
type: string
status:
type: integer
format: int32
count:
type: integer
format: int64
GrantedAuthority:
properties:
authority:
type: string
ClientApplicationKey:
properties:
clientId:
type: string
clientSecret:
type: string
securitySchemes:
guardianAuth:
type: oauth2
scheme: bearer
bearerFormat: JWT
flows:
implicit:
authorizationUrl: https://login.truste.com/oauth/authorize
tokenUrl: https://login.truste.com/oauth/token
scopes:
openid: OpenID
x-provenance:
method: harvested
publisher: TrustArc
source: https://login.truste.com/v3/api-docs
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)