Register Identity Provider

licensemanagerusersubscriptions_register_identity_provider

R Documentation

Registers an identity provider for user-based subscriptions

Description

Registers an identity provider for user-based subscriptions.

Usage

licensemanagerusersubscriptions_register_identity_provider(
  IdentityProvider, Product, Settings, Tags)

Arguments

IdentityProvider

[required] An object that specifies details for the identity provider to register.

Product

[required] The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Settings

The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

Tags

The tags that apply to the identity provider's registration.

Value

A list with the following syntax:

list(
  IdentityProviderSummary = list(
    FailureMessage = "string",
    IdentityProvider = list(
      ActiveDirectoryIdentityProvider = list(
        ActiveDirectorySettings = list(
          DomainCredentialsProvider = list(
            SecretsManagerCredentialsProvider = list(
              SecretId = "string"
            )
          ),
          DomainIpv4List = list(
            "string"
          ),
          DomainName = "string",
          DomainNetworkSettings = list(
            Subnets = list(
              "string"
            )
          )
        ),
        ActiveDirectoryType = "SELF_MANAGED"|"AWS_MANAGED",
        DirectoryId = "string"
      )
    ),
    IdentityProviderArn = "string",
    Product = "string",
    Settings = list(
      SecurityGroupId = "string",
      Subnets = list(
        "string"
      )
    ),
    Status = "string"
  )
)

Request syntax

svc$register_identity_provider(
  IdentityProvider = list(
    ActiveDirectoryIdentityProvider = list(
      ActiveDirectorySettings = list(
        DomainCredentialsProvider = list(
          SecretsManagerCredentialsProvider = list(
            SecretId = "string"
          )
        ),
        DomainIpv4List = list(
          "string"
        ),
        DomainName = "string",
        DomainNetworkSettings = list(
          Subnets = list(
            "string"
          )
        )
      ),
      ActiveDirectoryType = "SELF_MANAGED"|"AWS_MANAGED",
      DirectoryId = "string"
    )
  ),
  Product = "string",
  Settings = list(
    SecurityGroupId = "string",
    Subnets = list(
      "string"
    )
  ),
  Tags = list(
    "string"
  )
)