Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit b063d18

Browse files
authored
Merge pull request #220 from CloudHealth/SSO-Config-Update
SSO config update
2 parents ce4d772 + 64b39a7 commit b063d18

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

_sso/configure-sso.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configure SSO
33
position: 1
4-
description: Create or update SSO configuration in the CloudHealth Platform.
4+
description: Create or update SSO configuration in the CloudHealth platform.
55
type: put
66
endpoint: https://chapi.cloudhealthtech.com/v1/sso/configure
77
parameters:
@@ -10,7 +10,10 @@ parameters:
1010
content: String that specifies the unique customer API Key that CloudHealth generates. See [How to Get Client API ID](#partner_how-to-get-client-api-id).
1111
- name: sso_provider
1212
required: yes
13-
content: String that specifies the unique display name of an AWS account. Specify `samlp` (SAML), `google-apps` (Google Apps), or `waad` (Azure AD).
13+
content: String that specifies the unique display name of an AWS account. Specify `ah-saml` (SAML), or `ah-waad` (Azure AD).
14+
- name: issuer
15+
required: yes
16+
content: String that specifies the SAML Issuer or Entity ID.
1417
- name: domains
1518
required: yes
1619
content: Array that specifies SSO domains, with each domain specified in `company.com` format.
@@ -28,14 +31,14 @@ parameters:
2831
content: Boolean that specifies whether the IdP does not support passing the organization to which a new user should be assigned. Default value is `false`.
2932
- name: azure_ad_roles_protocol
3033
required: yes, if `sso_provider == waad`
31-
content: Boolean that specifies whether the Azure Roles protocol is used to pass roles to the CloudHealth Platform. Default value is `true`.
34+
content: Boolean that specifies whether the Azure Roles protocol is used to pass roles to the CloudHealth platform. Default value is `true`.
3235
right_code_blocks:
3336
- code_block: |-
34-
curl -X PUT -H 'Authorization: Bearer <your_api_key>' -H 'Content-Type: application/json' -d '{"sso_provider":"google-apps", "domains":["cloudhealthtech.com"]}' 'https://chapi.cloudhealthtech.com/v1/sso/configure'
37+
curl -X PUT -H 'Authorization: Bearer API_KEY' -H 'Content-Type: application/json' -d '{"sso_provider": <"ah-samlp"|"ah-waad">, "domains": ["<domain-1>,...,<domain-N>"], "signing_cert": "<cert>", "sign_in_endpoint": "<sign_in_endpoint>", "issuer": "<issuer>", "sso_ignore_idp_organization": <true|false>}' 'https://chapi.cloudhealthtech.com/v1/sso/configure'
3538
title: Request Body
3639
language: bash
3740
- code_block: |-
38-
{"success":"SSO configured for CloudHealth Technologies", "configuration_url": "www.provider.com/configure" }
41+
{"identityProviderId":"<idp-guid>","verifyCertAlias":"cloudhealth-<id>","samlMDidpRedirectBindingURL":"<sign_in_endpoint>","issuer":"<issuer>","cert":"<cert>","message":"SSO configured for <customer>"}
3942
title: Response
4043
language: json
4144
---

0 commit comments

Comments
 (0)