Amazon WorkLink
API Reference (API Version 2018-09-25)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AssociateWebsiteAuthorizationProvider

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

Request Syntax

POST /associateWebsiteAuthorizationProvider HTTP/1.1 Content-type: application/json { "AuthorizationProviderType": "string", "DomainName": "string", "FleetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AuthorizationProviderType

The authorization provider type.

Type: String

Valid Values: SAML

Required: Yes

DomainName

The domain name of the authorization provider. This applies only to SAML-based authorization providers.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+$

Required: No

FleetArn

The ARN of the fleet.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AuthorizationProviderId": "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.

AuthorizationProviderId

A unique identifier for the authorization provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerErrorException

The service is temporarily unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource already exists.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

TooManyRequestsException

The number of requests exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this action.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: