RegisterOpentdfConfig
Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.
Request Syntax
POST /networks/networkId/tdf?dryRun=dryRun HTTP/1.1
Content-type: application/json
{
"clientId": "string",
"clientSecret": "string",
"domain": "string",
"provider": "string"
}URI Request Parameters
The request uses the following URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientId
-
The OIDC client ID used for authenticating with the OpenTDF provider.
Type: String
Pattern:
[\S\s]*Required: Yes
- clientSecret
-
The OIDC client secret used for authenticating with the OpenTDF provider
Type: String
Pattern:
[\S\s]*Required: Yes
- domain
-
The domain of the OpenTDF server.
Type: String
Pattern:
[\S\s]*Required: Yes
- provider
-
The provider of the OpenTDF platform.
Note
Currently only Virtru is supported as the OpenTDF provider.
Type: String
Pattern:
[\S\s]*Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"clientId": "string",
"clientSecret": "string",
"domain": "string",
"provider": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- clientId
-
The OIDC client ID used for authenticating with the OpenTDF provider.
Type: String
Pattern:
[\S\s]* - clientSecret
-
The OIDC client secret used for authenticating with the OpenTDF provider.
Type: String
Pattern:
[\S\s]* - domain
-
The domain of the OpenTDF server.
Type: String
Pattern:
[\S\s]* - provider
-
The provider of the OpenTDF platform.
Type: String
Pattern:
[\S\s]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestError
-
The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.
- message
-
A detailed message explaining what was wrong with the request and how to correct it.
HTTP Status Code: 400
- ForbiddenError
-
Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.
- message
-
A message explaining why access was denied and what permissions are required.
HTTP Status Code: 403
- InternalServerError
-
An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact AWS Support.
- message
-
A message describing the internal server error that occurred.
HTTP Status Code: 500
- RateLimitError
-
The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.
- message
-
A message indicating that the rate limit was exceeded and suggesting when to retry.
HTTP Status Code: 429
- ResourceNotFoundError
-
The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.
- message
-
A message identifying which resource was not found.
HTTP Status Code: 404
- UnauthorizedError
-
The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.
- message
-
A message explaining why the authentication failed.
HTTP Status Code: 401
- ValidationError
-
One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.
- message
-
A message describing the validation error error that occurred.
- reasons
-
A list of validation error details, where each item identifies a specific field that failed validation and explains the reason for the failure.
HTTP Status Code: 422
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
