TPS REST API v1

Overview

This page describes the services provided by TPS REST API v1.

REST URL

Each resource will have a unique URL which will be in the following pattern:

• Single resource: /tps/rest/<resource name>

• Collection of resources: /tps/rest/<resource collection>/<resource ID>

REST Operations

The current TPS operations (eg. op=…​) will be mapped into the following HTTP operations:

• GET: searching resources or retrieving individual resource

• POST: adding an object

• PATCH: modifying an object

• DELETE: removing an object

All requests and responses will be sent in XML/JSON format.

These operations will return HTTP 200 (OK) return code upon successful operation. One exception is a successful add operation will return HTTP 201 (Created) and the URL of the newly created resource. Normal application errors will return HTTP 4xx return code. Unexpected server error will return HTTP 5xx return code.

Search operations may support paging. The server will return one page that contains a subset of the search result. The server will also return the total number of entries in the result. The client may request a specific page and also the number of entries per page.

The add and modify operations will return the updated object back, similar to the result of a GET operation. This way the client does not need to send another request to get the object after performing an update.

Some of the TPS operations will not be mapped into REST operations because the are purely used to generate the HTML page which is irrelevant for REST.

Deprecated doc pages to be removed - see latest docs here

= Account Services

• Login

• Logout

= User Services

• Search Users

• Add User

• Get User

• Modify User

• Remove User

= User Certificate Services

• List User Certificates

• Add User Certificate

• Retrieve User Certificate

• Delete User Certificate

= User Roles Services

• List User Roles

• Add User Role

• Delete User Role

= Group Services

• List Groups

• Retrieve Group

• Add Group

• Modify Group

• Delete Group

= Group Member Services

• List Group Members

• Retrieve Group Member

• Add Group Member

• Delete Group Member

Token Services

Path	Method	Service
/tps/rest/tokens	GET	Search Tokens
/tps/rest/tokens	POST	Add Token
/tps/rest/tokens/{id}	GET	Get Token
/tps/rest/tokens/{id}	PATCH	Modify Token
/tps/rest/tokens/{id}	POST	Change Token State
/tps/rest/tokens/{id}	DELETE	Remove Token

Certificate Services

Path	Method	Service
/tps/rest/certs	GET	Search Certificates
/tps/rest/certs/{id}	GET	Get Certificate

Activity Services

Path	Method	Service
/tps/rest/activities	GET	Search Activities
/tps/rest/activities/{id}	GET	Get Activity

Self Test Services

Path	Method	Service
/tps/rest/selftests	GET	Get Self Tests
/tps/rest/selftests	POST	Run Self Tests

Audit Services

Path	Method	Service
/tps/rest/audit	GET	Get Audit Configuration
/tps/rest/audit	PATCH	Modify Audit Configuration

Profile Services

• Search Profiles

• Add Profile

• Get Profile

• Modify Profile

• Change Profile State

• Remove Profile

Profile Mapping Services

• Search Profile Mappings

• Add Profile Mapping

• Get Profile Mapping

• Modify Profile Mapping

• Remove Profile Mapping

Connection Services

• Search Connections

• Add Connection

• Get Connection

• Modify Connection

• Remove Connection

Authenticator Services

• Search Authenticators

• Add Authenticator

• Get Authenticator

• Modify Authenticator

• Remove Authenticator

Configuration Services

• Get Configuration

• Modify Configuration

See Also

• PKI REST API Design

• Token Processing System