New-VCFIdentityProvider¶

Synopsis¶

Configures an identity provider.

Syntax¶

New-VCFIdentityProvider [-type] <String> [-json] <String> [<CommonParameters>]

Description¶

The New-VCFIdentityProvider cmdlet configures an embedded or external identity provider from a JSON specification file.

Examples¶

Example 1¶

New-VCFIdentityProvider -type Embedded -json .\samples\idp\embeddedIdpSpec.json

This example shows how to configure an embedded identity provider from the JSON specification file.

Sample JSON: Embedded Identity Provider

{
  "name": "SFO01",
  "ldap": {
    "domainName": "sfo.rainpole.io",
    "password": "VMw@re123!",
    "type": "ActiveDirectory",
    "username": "svc-vsphere-ad@sfo.rainpole.io",
    "sourceDetails": {
      "certChain": [
        "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURkVENDQWwyZ0F3SUJBZ0lRUTloMjhIamk2SXBLMjZwVW9nenVxVEFOQmdrcWhraUc5dzBCQVFzRkFEQk4KTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXNaQUVaRmdoeVlXbHVjRzlzWlRFZApNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3SGhjTk1qTXdOVEU0TURjeE56RXlXaGNOCk1qZ3dOVEU0TURjeU56RXhXakJOTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXMKWkFFWkZnaHlZV2x1Y0c5c1pURWRNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3Z2dFaQpNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUJEd0F3Z2dFS0FvSUJBUUNaTjlBaDY1aVpobGJPbUVRTDJXSjNCZk1BClB6WVhLWnc4Rkh4bkl3eE8vRU93QkxnM0R3YVpMck8yR1UrdVlGTDI0VUh2WVBvVVNpcTRyeHZIN0RzQWFpWFIKRjloeUEyemJyMFJVY25nWXdPdXJTMlhoazBBbG9YSzBqNVJkcE1vUzRYZFAyaXY1Rkk0NHBpeWJBY2hwM0dMVQorNCtqUFJWc2Nma3J1OVhDeTMwemdkdkQrTFAvZzE1ZTdZUjFGYkszcGNGUmFIU2FsL2FRdXRuTlZTbDk5b0xyCnpDRlNFcnArYVVXdVh5d2N4dXU3WjE1TU5Qd3BVdzIwQXdNUmM3cmoyVnJaZmZwTitLUVRFMm9CUmZHWU9rYS8KcHVQMW5iUm1MS0pjME0zWjJrNDQzM1JDSEVQL3F0WVJhMG45aHN1cFBvQUJOM1EwcTQxanVtcll2SWhGQWdNQgpBQUdqVVRCUE1Bc0dBMVVkRHdRRUF3SUJoakFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQjBHQTFVZERnUVdCQlNMCk9rTWVaWnNoQ0RMR1lxejBOVXBmb1lEWVJUQVFCZ2tyQmdFRUFZSTNGUUVFQXdJQkFEQU5CZ2txaGtpRzl3MEIKQVFzRkFBT0NBUUVBaTlPdjhpT1lUcUxicnIrLzhLbXBYRzkxY0thQWRtTHBIck5QaktvWUF4UUFGOEtPQlBEeQprZlNBa3NxWWRaV01JQzVjbUFyby9vMnJhbGh1K2NkN04wWThlbUUyUkJkUml3UnZVTjFpVlFkQkNuMXRPQ3FTCjVHWFNHMzRNR1J4OVUraUlYSHQyUUhmekUwMVdHeVdnYW8wRjV0RFliV3NCMDA5bkhmQjc3YjNxR1cwbHlOVG4KQXllT1RrRm12cSsyT3VOR2poQm5ydjJBaXpucTRJQStteG12WnU0Y29ZY0ZOQTBLSlBKVVdZcWZMVnE2SzdydQowaVJVUUpuQTN6cFVKemNxRXBscDlsQ3J0aFF6MVVtMzdVZkRpMzJ1K0lQeUt2c2lMQ3FCYzE3ME80ZXZ3QWhUCmovaFYxbzkzQUVUS2hnUWI1NlpXRFNsTXUxMWVMazhPbXc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
      ],
      "serverEndpoints": [
        "ldaps://sfo-dc01.sfo.rainpole.io:636"
      ],
      "groupsBaseDn": "OU=Security Groups,DC=sfo,DC=rainpole,DC=io",
      "usersBaseDn": "OU=Security Users,DC=sfo,DC=rainpole,DC=io"
    }
  }
}

Example 2¶

New-VCFIdentityProvider -type "Microsoft ADFS" -json .\samples\idp\externalIdpSpec.json

This example shows how to configure an external identity provider from the JSON specification file.

Sample JSON: External Identity Provider

{
  "name": "ADFS01",
  "type": "AD_FS",
  "certChain": [
    "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURkVENDQWwyZ0F3SUJBZ0lRUTloMjhIamk2SXBLMjZwVW9nenVxVEFOQmdrcWhraUc5dzBCQVFzRkFEQk4KTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXNaQUVaRmdoeVlXbHVjRzlzWlRFZApNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3SGhjTk1qTXdOVEU0TURjeE56RXlXaGNOCk1qZ3dOVEU0TURjeU56RXhXakJOTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXMKWkFFWkZnaHlZV2x1Y0c5c1pURWRNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3Z2dFaQpNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUJEd0F3Z2dFS0FvSUJBUUNaTjlBaDY1aVpobGJPbUVRTDJXSjNCZk1BClB6WVhLWnc4Rkh4bkl3eE8vRU93QkxnM0R3YVpMck8yR1UrdVlGTDI0VUh2WVBvVVNpcTRyeHZIN0RzQWFpWFIKRjloeUEyemJyMFJVY25nWXdPdXJTMlhoazBBbG9YSzBqNVJkcE1vUzRYZFAyaXY1Rkk0NHBpeWJBY2hwM0dMVQorNCtqUFJWc2Nma3J1OVhDeTMwemdkdkQrTFAvZzE1ZTdZUjFGYkszcGNGUmFIU2FsL2FRdXRuTlZTbDk5b0xyCnpDRlNFcnArYVVXdVh5d2N4dXU3WjE1TU5Qd3BVdzIwQXdNUmM3cmoyVnJaZmZwTitLUVRFMm9CUmZHWU9rYS8KcHVQMW5iUm1MS0pjME0zWjJrNDQzM1JDSEVQL3F0WVJhMG45aHN1cFBvQUJOM1EwcTQxanVtcll2SWhGQWdNQgpBQUdqVVRCUE1Bc0dBMVVkRHdRRUF3SUJoakFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQjBHQTFVZERnUVdCQlNMCk9rTWVaWnNoQ0RMR1lxejBOVXBmb1lEWVJUQVFCZ2tyQmdFRUFZSTNGUUVFQXdJQkFEQU5CZ2txaGtpRzl3MEIKQVFzRkFBT0NBUUVBaTlPdjhpT1lUcUxicnIrLzhLbXBYRzkxY0thQWRtTHBIck5QaktvWUF4UUFGOEtPQlBEeQprZlNBa3NxWWRaV01JQzVjbUFyby9vMnJhbGh1K2NkN04wWThlbUUyUkJkUml3UnZVTjFpVlFkQkNuMXRPQ3FTCjVHWFNHMzRNR1J4OVUraUlYSHQyUUhmekUwMVdHeVdnYW8wRjV0RFliV3NCMDA5bkhmQjc3YjNxR1cwbHlOVG4KQXllT1RrRm12cSsyT3VOR2poQm5ydjJBaXpucTRJQStteG12WnU0Y29ZY0ZOQTBLSlBKVVdZcWZMVnE2SzdydQowaVJVUUpuQTN6cFVKemNxRXBscDlsQ3J0aFF6MVVtMzdVZkRpMzJ1K0lQeUt2c2lMQ3FCYzE3ME80ZXZ3QWhUCmovaFYxbzkzQUVUS2hnUWI1NlpXRFNsTXUxMWVMazhPbXc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
  ],
  "ldap": {
    "username": "svc-vcf-ca@rainpole.io",
    "password": "VMw@re123!",
    "sourceDetails": {
      "certChain": [],
      "serverEndpoints": [
        "ldap://rpl-dc01.rainpole.io:389"
      ],
      "groupsBaseDn": "OU=Security Groups,DC=rainpole,DC=io",
      "usersBaseDn": "OU=Security Users,DC=rainpole,DC=io"
    }
  },
  "oidc": {
    "clientId": "d49b72f6-ec04-41bb-bad6-aad368af2fe5",
    "clientSecret": "HFEH59piO3NfzbFp9O5rGskCVEdBQ_aM8dTPo8wer",
    "discoveryEndpoint": "https://rpl-dc01.rainpole.io/adfs/.well-known/openid-configuration"
  }
}

Parameters¶

-type¶

Specifies the type of the identity provider. One of: Embedded, Microsoft ADFS.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-json¶

Specifies the JSON specification file to be used.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters¶

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.