# RegisterIdentityProvider
<a name="API_RegisterIdentityProvider"></a>

Registers an identity provider for user-based subscriptions.

## Request Syntax
<a name="API_RegisterIdentityProvider_RequestSyntax"></a>

```
POST /identity-provider/RegisterIdentityProvider HTTP/1.1
Content-type: application/json

{
   "IdentityProvider": { ... },
   "Product": "string",
   "Settings": { 
      "SecurityGroupId": "string",
      "Subnets": [ "string" ]
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_RegisterIdentityProvider_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_RegisterIdentityProvider_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [IdentityProvider](#API_RegisterIdentityProvider_RequestSyntax) **   <a name="licensemanagerusersubscriptions-RegisterIdentityProvider-request-IdentityProvider"></a>
An object that specifies details for the identity provider to register.  
Type: [IdentityProvider](API_IdentityProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [Product](#API_RegisterIdentityProvider_RequestSyntax) **   <a name="licensemanagerusersubscriptions-RegisterIdentityProvider-request-Product"></a>
The name of the user-based subscription product.  
Valid values: `VISUAL_STUDIO_ENTERPRISE` \$1 `VISUAL_STUDIO_PROFESSIONAL` \$1 `OFFICE_PROFESSIONAL_PLUS` \$1 `REMOTE_DESKTOP_SERVICES`   
Type: String  
Required: Yes

 ** [Settings](#API_RegisterIdentityProvider_RequestSyntax) **   <a name="licensemanagerusersubscriptions-RegisterIdentityProvider-request-Settings"></a>
The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.  
Type: [Settings](API_Settings.md) object  
Required: No

 ** [Tags](#API_RegisterIdentityProvider_RequestSyntax) **   <a name="licensemanagerusersubscriptions-RegisterIdentityProvider-request-Tags"></a>
The tags that apply to the identity provider's registration.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_RegisterIdentityProvider_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IdentityProviderSummary": { 
      "FailureMessage": "string",
      "IdentityProvider": { ... },
      "IdentityProviderArn": "string",
      "OwnerAccountId": "string",
      "Product": "string",
      "Settings": { 
         "SecurityGroupId": "string",
         "Subnets": [ "string" ]
      },
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_RegisterIdentityProvider_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IdentityProviderSummary](#API_RegisterIdentityProvider_ResponseSyntax) **   <a name="licensemanagerusersubscriptions-RegisterIdentityProvider-response-IdentityProviderSummary"></a>
Metadata that describes the results of an identity provider operation.  
Type: [IdentityProviderSummary](API_IdentityProviderSummary.md) object

## Errors
<a name="API_RegisterIdentityProvider_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The request couldn't be completed because it conflicted with the current state of the resource.  
HTTP Status Code: 500

 ** InternalServerException **   
An exception occurred with the service.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request failed because a service quota is exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied because of request throttling. Retry the request.  
HTTP Status Code: 400

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_RegisterIdentityProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider)