---
title: "POST /identity-provider/RegisterIdentityProvider"
method: POST
path: "/identity-provider/RegisterIdentityProvider"
---

# POST /identity-provider/RegisterIdentityProvider

`POST /identity-provider/RegisterIdentityProvider`

Registers an identity provider for user-based subscriptions.

## Request body

- object
  - `IdentityProvider` object, required — Refers to an identity provider.
    - `ActiveDirectoryIdentityProvider` object — The <code>ActiveDirectoryIdentityProvider</code> resource contains settings and other details about a specific Active Directory identity provider.
      - `DirectoryId` string — The directory ID for an Active Directory identity provider.
      - `ActiveDirectorySettings` object — The <code>ActiveDirectorySettings</code> resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
        - `DomainName` string — The domain name for the Active Directory.
        - `DomainIpv4List` IpV4[] — A list of domain IPv4 addresses that are used for the Active Directory.
        - `DomainIpv6List` IpV6[] — A list of domain IPv6 addresses that are used for the Active Directory.
        - `DomainCredentialsProvider` object — Points to the <code>CredentialsProvider</code> resource that contains information about the credential provider for user administration.
          - `SecretsManagerCredentialsProvider` object — Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
            - `SecretId` string — The ID of the Secrets Manager secret that contains credentials.
        - `DomainNetworkSettings` object — The <code>DomainNetworkSettings</code> resource contains an array of subnets that apply for the Active Directory.
          - `Subnets` Subnet[], required — Contains a list of subnets that apply for the Active Directory domain.
      - `ActiveDirectoryType` 'SELF_MANAGED' | 'AWS_MANAGED' — The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
      - `IsSharedActiveDirectory` boolean — Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
  - `Product` string, required — <p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>
  - `Settings` object — The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.
    - `Subnets` Subnet[] — The subnets defined for the registered identity provider.
    - `SecurityGroupId` string — A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
  - `Tags` object — The tags that apply to the identity provider's registration.

## Response `200`

Success

- RegisterIdentityProviderResponse
  - `IdentityProviderSummary` object, required — Metadata that describes the results of an identity provider operation.
    - `IdentityProvider` object, required — The <code>IdentityProvider</code> resource contains information about an identity provider.
      - `ActiveDirectoryIdentityProvider` object — The <code>ActiveDirectoryIdentityProvider</code> resource contains settings and other details about a specific Active Directory identity provider.
        - `DirectoryId` string — The directory ID for an Active Directory identity provider.
        - `ActiveDirectorySettings` object — The <code>ActiveDirectorySettings</code> resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
          - `DomainName` string — The domain name for the Active Directory.
          - `DomainIpv4List` IpV4[] — A list of domain IPv4 addresses that are used for the Active Directory.
          - `DomainIpv6List` IpV6[] — A list of domain IPv6 addresses that are used for the Active Directory.
          - `DomainCredentialsProvider` object — Points to the <code>CredentialsProvider</code> resource that contains information about the credential provider for user administration.
            - `SecretsManagerCredentialsProvider` object — Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
              - …
          - `DomainNetworkSettings` object — The <code>DomainNetworkSettings</code> resource contains an array of subnets that apply for the Active Directory.
            - `Subnets` Subnet[], required — Contains a list of subnets that apply for the Active Directory domain.
        - `ActiveDirectoryType` 'SELF_MANAGED' | 'AWS_MANAGED' — The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
        - `IsSharedActiveDirectory` boolean — Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
    - `Settings` object, required — The <code>Settings</code> resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
      - `Subnets` Subnet[], required — The subnets defined for the registered identity provider.
      - `SecurityGroupId` string, required — A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
    - `Product` string, required — The name of the user-based subscription product.
    - `Status` string, required — The status of the identity provider.
    - `IdentityProviderArn` string — The Amazon Resource Name (ARN) of the identity provider.
    - `FailureMessage` string — The failure message associated with an identity provider.
    - `OwnerAccountId` string — The AWS Account ID of the owner of this resource.

## Other responses

- `480` — ServiceQuotaExceededException
- `481` — ValidationException
- `482` — ConflictException
- `483` — ThrottlingException
- `484` — InternalServerException
- `485` — ResourceNotFoundException
- `486` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/license-manager-user-subscriptions.md) · [All operations](https://skmtc.net/aws/apis/license-manager-user-subscriptions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/license-manager-user-subscriptions/versions/3f333914dcdb/schema)