Servers
Manage server accounts and their certificates.
Get a server
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/v3/servers/{serverId}/generateBundleUrl.
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. An AWS role id the server does not already have must belong to an existing AWS role. 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. Certificate files are stored under a name derived from fullName, so after fullName changes, download links point to a bundle that does not exist and POST /tap/api/v3/servers/{serverId}/certificate/bundle builds a bundle without the server's certificate until the certificate is rebuilt. Requires the admin role. bundlePath in the response is the stored location of the certificate bundle, not a download link.
Delete a server
Deletes a server and removes its certificate files and certificate bundle. Files stored under an earlier fullName may not be removed. Requires the admin role.
Get a server certificate bundle download link
Returns a presigned URL, valid for 12 hours by default, 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 12 hours by default when the showBundleLinks setting is on, and attaches the bundle when the sendWelcomeEmailWithAttachment setting is on.
List servers
Returns a summary of each server. The complete server is available from GET /tap/api/v3/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
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. Each AWS role id in awsRoles must belong to an existing AWS role; 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 12 hours by default 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/v3/servers/{serverId}/resend can send it later. bundlePath in the response is the stored location of the certificate bundle, not a download link.
Get a server (v2)
Deprecated; use GET /tap/api/v3/servers/{serverId}. Returns a single server by its identifier. Requires the admin role. Differs from v3 only in awsRoles, which lists AWS role objects instead of AWS role ids. bundlePath is the stored location of the certificate bundle, not a download link; use GET /tap/api/v3/servers/{serverId}/generateBundleUrl.
Update a server (v2)
Deprecated; use PUT /tap/api/v3/servers/{serverId}. Differs from v3 only in awsRoles: the request accepts AWS role objects, of which only id is read, as well as AWS role ids, and the response lists AWS role objects. 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. An AWS role id the server does not already have must belong to an existing AWS role. 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. Certificate files are stored under a name derived from fullName, so after fullName changes, download links point to a bundle that does not exist and POST /tap/api/v3/servers/{serverId}/certificate/bundle builds a bundle without the server's certificate until the certificate is rebuilt. Requires the admin role. bundlePath in the response is the stored location of the certificate bundle, not a download link.
List servers (v2)
Deprecated; use GET /tap/api/v3/servers, which behaves identically. Returns a summary of each server. The complete server is available from GET /tap/api/v3/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)
Deprecated; use POST /tap/api/v3/servers. Differs from v3 only in awsRoles: the request accepts AWS role objects, of which only id is read, as well as AWS role ids, and the response lists AWS role objects. 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. Each AWS role id in awsRoles must belong to an existing AWS role; 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 12 hours by default 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/v3/servers/{serverId}/resend can send it later. bundlePath in the response is the stored location of the certificate bundle, not a download link.
Get a server (v1)
Deprecated; use GET /tap/api/v3/servers/{serverId}. Returns a single server by its identifier. Requires the admin role. Differs from v3 in two ways: awsRoles lists AWS role objects instead of AWS role ids, and a non-empty bundlePath is replaced with a presigned download link valid for 12 hours by default, or left as the stored location when the link cannot be generated.
Update a server (v1)
Deprecated; use PUT /tap/api/v3/servers/{serverId}. Differs from v3 in awsRoles and bundlePath: the request accepts AWS role objects, of which only id is read, as well as AWS role ids; the response lists AWS role objects; and a non-empty bundlePath in the response is replaced with a presigned download link valid for 12 hours by default, or left as the stored location when the link cannot be generated. 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. An AWS role id the server does not already have must belong to an existing AWS role. 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. Certificate files are stored under a name derived from fullName, so after fullName changes, download links point to a bundle that does not exist and POST /tap/api/v3/servers/{serverId}/certificate/bundle builds a bundle without the server's certificate until the certificate is rebuilt. Requires the admin role.
List servers (v1)
Deprecated; use GET /tap/api/v3/servers. Unlike v3, returns every server with all of its fields, sorted by fullName, with awsRoles as AWS role objects. 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.
Create a server (v1)
Deprecated; use POST /tap/api/v3/servers. Differs from v3 in awsRoles and bundlePath: the request accepts AWS role objects, of which only id is read, as well as AWS role ids; the response lists AWS role objects; and a non-empty bundlePath in the response is replaced with a presigned download link valid for 12 hours by default, or left as the stored location when the link cannot be generated. 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. Each AWS role id in awsRoles must belong to an existing AWS role; 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 12 hours by default 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/v3/servers/{serverId}/resend can send it later.