Servers
Manage server accounts and their certificates.
Get a server
Returns a single server by its identifier. Requires the admin role. A non-empty bundlePath is replaced with a presigned download link valid for up to 8 hours.
Update a server
Updates a server. Only fullName, email, active, custodianName, domains, and awsRoles are read; a field that is omitted or null is left unchanged, and every other field, including csr, is ignored. When email domain validation is on, the resulting email is checked even when email is not sent. Changing fullName or domains does not issue a new certificate. Requires the admin role. A non-empty bundlePath in the response is replaced with a presigned download link valid for up to 8 hours.
Delete a server
Deletes a server and removes its certificate files and certificate bundle. Requires the admin role.
Get a server certificate bundle download link
Returns a presigned URL, valid for up to 8 hours, for downloading the server's certificate bundle. The link is generated without checking that the bundle exists. Requires the admin role.
Rebuild a server certificate
Issues the server a new certificate and rebuilds its certificate bundle. When the server was created from a CSR, the stored CSR is signed again; otherwise a new key pair and password are generated. No email is sent. Requires the admin role.
Rebuild a server certificate bundle
Rebuilds and stores the server's certificate bundle from the server's existing certificate files. The certificate is not reissued. Requires the admin role.
Resend the certificate email
Resends the certificate bundle email to the server's custodian. Requires the admin role and email integration. The email is sent whether or not the sendWelcomeEmail setting is on; it includes a download link valid for up to 8 hours when the showBundleLinks setting is on, and attaches the bundle when the sendWelcomeEmailWithAttachment setting is on.
List servers
Returns every server with all of its fields, sorted by fullName. Requires the admin role; a caller with the user role receives an empty list. This version does not page, search, or filter, and ignores query parameters. bundlePath in each server is the stored location of the certificate bundle, not a download link. For summaries with paging and search, use GET /tap/api/v2/servers.
Create a server
Creates a server and issues its certificate. When csr is not blank, the CSR is signed and the certificate bundle contains no private key; otherwise a key pair and password are generated. The default AWS roles are assigned when awsRoles is omitted or empty. Requires the admin role. When the sendWelcomeEmail setting is on and email integration is enabled, the custodian is sent an email; it includes a download link valid for up to 8 hours when the showBundleLinks setting is on, and attaches the bundle when the sendWelcomeEmailWithAttachment setting is on. If the download link cannot be generated, the server is still created but no email is sent, and POST /tap/api/v1/servers/{serverId}/resend can send it later. bundlePath in the response is a presigned download link valid for up to 8 hours.
Get a server (v2)
Returns a single server by its identifier. Requires the admin role. bundlePath is the stored location of the certificate bundle, not a download link; use GET /tap/api/v2/servers/{serverId}/generateBundleUrl.
Update a server (v2)
Updates a server. Only fullName, email, active, custodianName, domains, and awsRoles are read; a field that is omitted or null is left unchanged, and every other field, including csr, is ignored. When email domain validation is on, the resulting email is checked even when email is not sent. Changing fullName or domains does not issue a new certificate. Requires the admin role. bundlePath in the response is the stored location of the certificate bundle, not a download link.
Delete a server (v2)
Deletes a server and removes its certificate files and certificate bundle. Requires the admin role.
Get a server certificate bundle download link (v2)
Returns a presigned URL, valid for up to 8 hours, for downloading the server's certificate bundle. The link is generated without checking that the bundle exists. In v2 this is the only way to get a download link: bundlePath in a Server is the stored location, not a link. Requires the admin role.
Rebuild a server certificate (v2)
Issues the server a new certificate and rebuilds its certificate bundle. When the server was created from a CSR, the stored CSR is signed again; otherwise a new key pair and password are generated. No email is sent. Requires the admin role.
Rebuild a server certificate bundle (v2)
Rebuilds and stores the server's certificate bundle from the server's existing certificate files. The certificate is not reissued. Requires the admin role.
Resend the certificate email (v2)
Resends the certificate bundle email to the server's custodian. Requires the admin role and email integration. The email is sent whether or not the sendWelcomeEmail setting is on; it includes a download link valid for up to 8 hours when the showBundleLinks setting is on, and attaches the bundle when the sendWelcomeEmailWithAttachment setting is on.
List servers (v2)
Returns a summary of each server. The complete server is available from GET /tap/api/v2/servers/{serverId}. Requires the admin role; a caller with the user role receives an empty list. A single page is returned when pageSize, page, nextToken, or q is not blank, or when active or includeCounts is true; otherwise every server is returned, sorted by fullName. A page is sorted by fullName, ignoring case and surrounding whitespace, then by id.
Create a server (v2)
Creates a server and issues its certificate. When csr is not blank, the CSR is signed and the certificate bundle contains no private key; otherwise a key pair and password are generated. The default AWS roles are assigned when awsRoles is omitted or empty. Requires the admin role. When the sendWelcomeEmail setting is on and email integration is enabled, the custodian is sent an email; it includes a download link valid for up to 8 hours when the showBundleLinks setting is on, and attaches the bundle when the sendWelcomeEmailWithAttachment setting is on. If the download link cannot be generated, the server is still created but no email is sent, and POST /tap/api/v2/servers/{serverId}/resend can send it later. bundlePath in the response is the stored location of the certificate bundle, not a download link.