Skip to content

Commit 1be5640

Browse files
rishabhpoddarrishabhpoddar
authored
Merge pull request #807 from supertokens/feat/dynamic-saml-provider-logo
Feat: dynamic saml provider logo
2 parents afcbeaf + 6177a0a commit 1be5640

File tree

6 files changed

+132
-33
lines changed

6 files changed

+132
-33
lines changed

‎v2/thirdparty/common-customizations/saml/with-boxyhq/integration-steps.mdx

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ import Multitenancy from "supertokens-node/recipe/multitenancy"
243243
async function addThirdPartyConfigToTenant() {
244244
let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
245245
thirdPartyId: "boxy-saml",
246-
name: "SAML Login",
246+
name: "<provider-name>",
247247
clients: [{
248248
clientId: "<TODO: GENERATED FROM PREVIOUS STEP>",
249249
clientSecret: "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -276,7 +276,7 @@ func main() {
276276
// highlight-start
277277
resp, err := multitenancy.CreateOrUpdateThirdPartyConfig(tenantId, tpmodels.ProviderConfig{
278278
ThirdPartyId: "boxy-saml",
279-
Name: "SAML Login",
279+
Name: "<provider-name>",
280280
Clients: []tpmodels.ProviderClientConfig{
281281
{
282282
ClientID: "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -313,7 +313,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
313313
async def some_func():
314314
result = await create_or_update_third_party_config("customer1", ProviderConfig(
315315
third_party_id="boxy-saml",
316-
name="SAML Login",
316+
name="<provider-name>",
317317
clients=[
318318
ProviderClientConfig(
319319
client_id="<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -343,7 +343,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
343343

344344
result = create_or_update_third_party_config("customer1", ProviderConfig(
345345
third_party_id="boxy-saml",
346-
name="SAML Login",
346+
name="<provider-name>",
347347
clients=[
348348
ProviderClientConfig(
349349
client_id="<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -379,7 +379,7 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
379379
--data-raw '{
380380
"config": {
381381
"thirdPartyId": "boxy-saml",
382-
"name": "SAML Login",
382+
"name": "<provider-name>",
383383
"clients": [
384384
{
385385
"clientId": "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -399,7 +399,22 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
399399

400400
</BackendSDKTabs>
401401

402-
- Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the boxy hq server. If you are using our SuperTokens managed service, we will host the Boxy HQ server for you ([reach out to us](mailto:[email protected]) to activate your instance).
402+
To configure SAML login with SuperTokens, ensure that you use the correct provider name in the third-party config.
403+
Make sure to replace <b>`<provider-name>`</b> in the code snippet above with one of the following
404+
405+
- Microsoft Entra ID <br/>
406+
- Microsoft AD FS <br/>
407+
- Okta <br/>
408+
- Auth0 <br/>
409+
- Google <br/>
410+
- OneLogin <br/>
411+
- PingOne <br/>
412+
- JumpCloud <br/>
413+
- Rippling <br/>
414+
- OpenID <br/>
415+
- Generic SAML <br/>
416+
417+
Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the boxy hq server. If you are using our SuperTokens managed service, we will host the Boxy HQ server for you ([reach out to us](mailto:[email protected]) to activate your instance).
403418

404419

405420
:::success

‎v2/thirdparty/common-customizations/sign-in-and-up/provider-config.mdx

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3593,6 +3593,7 @@ SuperTokens.init({
35933593
{
35943594
config: {
35953595
thirdPartyId: "boxy-saml",
3596+
name: "<provider-name>", // Replace with the correct provider name
35963597
clients: [{
35973598
clientId: "TODO",
35983599
clientSecret: "TODO",
@@ -3630,6 +3631,7 @@ func main() {
36303631
{
36313632
Config: tpmodels.ProviderConfig{
36323633
ThirdPartyId: "boxy-saml",
3634+
Name: "<provider-name>",
36333635
Clients: []tpmodels.ProviderClientConfig{
36343636
{
36353637
ClientID: "TODO:",
@@ -3671,6 +3673,7 @@ init(
36713673
ProviderInput(
36723674
config=ProviderConfig(
36733675
third_party_id="boxy-saml",
3676+
name="<provider-name>",
36743677
clients=[
36753678
ProviderClientConfig(
36763679
client_id="TODO:",
@@ -3710,7 +3713,7 @@ import Multitenancy from "supertokens-node/recipe/multitenancy";
37103713
async function addThirdPartyToTenant() {
37113714
let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
37123715
thirdPartyId: "boxy-saml",
3713-
name: "SAML",
3716+
name: "<provider-name>",
37143717
clients: [{
37153718
clientId: "...",
37163719
clientSecret: "...",
@@ -3744,7 +3747,7 @@ func main() {
37443747
// highlight-start
37453748
resp, err := multitenancy.CreateOrUpdateThirdPartyConfig(tenantId, tpmodels.ProviderConfig{
37463749
ThirdPartyId: "boxy-saml",
3747-
Name: "SAML",
3750+
Name: "<provider-name>",
37483751
Clients: []tpmodels.ProviderClientConfig{
37493752
{
37503753
ClientID: "...",
@@ -3784,7 +3787,7 @@ async def some_func():
37843787
tenant_id = "customer1"
37853788
result = await create_or_update_third_party_config(tenant_id, ProviderConfig(
37863789
third_party_id="boxy-saml",
3787-
name="SAML",
3790+
name="<provider-name>",
37883791
clients=[
37893792
ProviderClientConfig(
37903793
client_id="...",
@@ -3817,7 +3820,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
38173820
tenant_id = "customer1"
38183821
result = create_or_update_third_party_config(tenant_id, ProviderConfig(
38193822
third_party_id="boxy-saml",
3820-
name="SAML",
3823+
name="<provider-name>",
38213824
clients=[
38223825
ProviderClientConfig(
38233826
client_id="...",
@@ -3854,7 +3857,7 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
38543857
--data-raw '{
38553858
"config": {
38563859
"thirdPartyId": "boxy-SAML",
3857-
"name": "SAML",
3860+
"name": "<provider-name>",
38583861
"clients": [
38593862
{
38603863
"clientId": "...",
@@ -3877,3 +3880,18 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
38773880
</TabItem>
38783881

38793882
</MultiSingleTenant>
3883+
3884+
To configure SAML login with SuperTokens, ensure that you use the correct provider name in the third-party config.
3885+
Make sure to replace <b>`<provider-name>`</b> in the code snippet above with one of the following
3886+
3887+
- Microsoft Entra ID <br/>
3888+
- Microsoft AD FS <br/>
3889+
- Okta <br/>
3890+
- Auth0 <br/>
3891+
- Google <br/>
3892+
- OneLogin <br/>
3893+
- PingOne <br/>
3894+
- JumpCloud <br/>
3895+
- Rippling <br/>
3896+
- OpenID <br/>
3897+
- Generic SAML <br/>

‎v2/thirdpartyemailpassword/common-customizations/saml/with-boxyhq/integration-steps.mdx

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ import Multitenancy from "supertokens-node/recipe/multitenancy"
243243
async function addThirdPartyConfigToTenant() {
244244
let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
245245
thirdPartyId: "boxy-saml",
246-
name: "SAML Login",
246+
name: "<provider-name>",
247247
clients: [{
248248
clientId: "<TODO: GENERATED FROM PREVIOUS STEP>",
249249
clientSecret: "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -276,7 +276,7 @@ func main() {
276276
// highlight-start
277277
resp, err := multitenancy.CreateOrUpdateThirdPartyConfig(tenantId, tpmodels.ProviderConfig{
278278
ThirdPartyId: "boxy-saml",
279-
Name: "SAML Login",
279+
Name: "<provider-name>",
280280
Clients: []tpmodels.ProviderClientConfig{
281281
{
282282
ClientID: "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -313,7 +313,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
313313
async def some_func():
314314
result = await create_or_update_third_party_config("customer1", ProviderConfig(
315315
third_party_id="boxy-saml",
316-
name="SAML Login",
316+
name="<provider-name>",
317317
clients=[
318318
ProviderClientConfig(
319319
client_id="<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -343,7 +343,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
343343

344344
result = create_or_update_third_party_config("customer1", ProviderConfig(
345345
third_party_id="boxy-saml",
346-
name="SAML Login",
346+
name="<provider-name>",
347347
clients=[
348348
ProviderClientConfig(
349349
client_id="<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -379,7 +379,7 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
379379
--data-raw '{
380380
"config": {
381381
"thirdPartyId": "boxy-saml",
382-
"name": "SAML Login",
382+
"name": "<provider-name>",
383383
"clients": [
384384
{
385385
"clientId": "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -399,7 +399,22 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
399399

400400
</BackendSDKTabs>
401401

402-
- Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the boxy hq server. If you are using our SuperTokens managed service, we will host the Boxy HQ server for you ([reach out to us](mailto:[email protected]) to activate your instance).
402+
To configure SAML login with SuperTokens, ensure that you use the correct provider name in the third-party config.
403+
Make sure to replace <b>`<provider-name>`</b> in the code snippet above with one of the following
404+
405+
- Microsoft Entra ID <br/>
406+
- Microsoft AD FS <br/>
407+
- Okta <br/>
408+
- Auth0 <br/>
409+
- Google <br/>
410+
- OneLogin <br/>
411+
- PingOne <br/>
412+
- JumpCloud <br/>
413+
- Rippling <br/>
414+
- OpenID <br/>
415+
- Generic SAML <br/>
416+
417+
Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the boxy hq server. If you are using our SuperTokens managed service, we will host the Boxy HQ server for you ([reach out to us](mailto:[email protected]) to activate your instance).
403418

404419

405420
:::success

‎v2/thirdpartyemailpassword/common-customizations/sign-in-and-up/provider-config.mdx

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3593,6 +3593,7 @@ SuperTokens.init({
35933593
{
35943594
config: {
35953595
thirdPartyId: "boxy-saml",
3596+
name: "<provider-name>", // Replace with the correct provider name
35963597
clients: [{
35973598
clientId: "TODO",
35983599
clientSecret: "TODO",
@@ -3630,6 +3631,7 @@ func main() {
36303631
{
36313632
Config: tpmodels.ProviderConfig{
36323633
ThirdPartyId: "boxy-saml",
3634+
Name: "<provider-name>",
36333635
Clients: []tpmodels.ProviderClientConfig{
36343636
{
36353637
ClientID: "TODO:",
@@ -3671,6 +3673,7 @@ init(
36713673
ProviderInput(
36723674
config=ProviderConfig(
36733675
third_party_id="boxy-saml",
3676+
name="<provider-name>",
36743677
clients=[
36753678
ProviderClientConfig(
36763679
client_id="TODO:",
@@ -3710,7 +3713,7 @@ import Multitenancy from "supertokens-node/recipe/multitenancy";
37103713
async function addThirdPartyToTenant() {
37113714
let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
37123715
thirdPartyId: "boxy-saml",
3713-
name: "SAML",
3716+
name: "<provider-name>",
37143717
clients: [{
37153718
clientId: "...",
37163719
clientSecret: "...",
@@ -3744,7 +3747,7 @@ func main() {
37443747
// highlight-start
37453748
resp, err := multitenancy.CreateOrUpdateThirdPartyConfig(tenantId, tpmodels.ProviderConfig{
37463749
ThirdPartyId: "boxy-saml",
3747-
Name: "SAML",
3750+
Name: "<provider-name>",
37483751
Clients: []tpmodels.ProviderClientConfig{
37493752
{
37503753
ClientID: "...",
@@ -3784,7 +3787,7 @@ async def some_func():
37843787
tenant_id = "customer1"
37853788
result = await create_or_update_third_party_config(tenant_id, ProviderConfig(
37863789
third_party_id="boxy-saml",
3787-
name="SAML",
3790+
name="<provider-name>",
37883791
clients=[
37893792
ProviderClientConfig(
37903793
client_id="...",
@@ -3817,7 +3820,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
38173820
tenant_id = "customer1"
38183821
result = create_or_update_third_party_config(tenant_id, ProviderConfig(
38193822
third_party_id="boxy-saml",
3820-
name="SAML",
3823+
name="<provider-name>",
38213824
clients=[
38223825
ProviderClientConfig(
38233826
client_id="...",
@@ -3854,7 +3857,7 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
38543857
--data-raw '{
38553858
"config": {
38563859
"thirdPartyId": "boxy-SAML",
3857-
"name": "SAML",
3860+
"name": "<provider-name>",
38583861
"clients": [
38593862
{
38603863
"clientId": "...",
@@ -3877,3 +3880,18 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
38773880
</TabItem>
38783881

38793882
</MultiSingleTenant>
3883+
3884+
To configure SAML login with SuperTokens, ensure that you use the correct provider name in the third-party config.
3885+
Make sure to replace <b>`<provider-name>`</b> in the code snippet above with one of the following
3886+
3887+
- Microsoft Entra ID <br/>
3888+
- Microsoft AD FS <br/>
3889+
- Okta <br/>
3890+
- Auth0 <br/>
3891+
- Google <br/>
3892+
- OneLogin <br/>
3893+
- PingOne <br/>
3894+
- JumpCloud <br/>
3895+
- Rippling <br/>
3896+
- OpenID <br/>
3897+
- Generic SAML <br/>

‎v2/thirdpartypasswordless/common-customizations/saml/with-boxyhq/integration-steps.mdx

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ import Multitenancy from "supertokens-node/recipe/multitenancy"
243243
async function addThirdPartyConfigToTenant() {
244244
let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
245245
thirdPartyId: "boxy-saml",
246-
name: "SAML Login",
246+
name: "<provider-name>",
247247
clients: [{
248248
clientId: "<TODO: GENERATED FROM PREVIOUS STEP>",
249249
clientSecret: "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -276,7 +276,7 @@ func main() {
276276
// highlight-start
277277
resp, err := multitenancy.CreateOrUpdateThirdPartyConfig(tenantId, tpmodels.ProviderConfig{
278278
ThirdPartyId: "boxy-saml",
279-
Name: "SAML Login",
279+
Name: "<provider-name>",
280280
Clients: []tpmodels.ProviderClientConfig{
281281
{
282282
ClientID: "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -313,7 +313,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
313313
async def some_func():
314314
result = await create_or_update_third_party_config("customer1", ProviderConfig(
315315
third_party_id="boxy-saml",
316-
name="SAML Login",
316+
name="<provider-name>",
317317
clients=[
318318
ProviderClientConfig(
319319
client_id="<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -343,7 +343,7 @@ from supertokens_python.recipe.thirdparty.provider import ProviderConfig, Provid
343343

344344
result = create_or_update_third_party_config("customer1", ProviderConfig(
345345
third_party_id="boxy-saml",
346-
name="SAML Login",
346+
name="<provider-name>",
347347
clients=[
348348
ProviderClientConfig(
349349
client_id="<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -379,7 +379,7 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
379379
--data-raw '{
380380
"config": {
381381
"thirdPartyId": "boxy-saml",
382-
"name": "SAML Login",
382+
"name": "<provider-name>",
383383
"clients": [
384384
{
385385
"clientId": "<TODO: GENERATED FROM PREVIOUS STEP>",
@@ -399,7 +399,22 @@ curl --location --request PUT '^{coreInjector_uri_without_quotes}/<TENANT_ID>/re
399399

400400
</BackendSDKTabs>
401401

402-
- Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the boxy hq server. If you are using our SuperTokens managed service, we will host the Boxy HQ server for you ([reach out to us](mailto:[email protected]) to activate your instance).
402+
To configure SAML login with SuperTokens, ensure that you use the correct provider name in the third-party config.
403+
Make sure to replace <b>`<provider-name>`</b> in the code snippet above with one of the following
404+
405+
- Microsoft Entra ID <br/>
406+
- Microsoft AD FS <br/>
407+
- Okta <br/>
408+
- Auth0 <br/>
409+
- Google <br/>
410+
- OneLogin <br/>
411+
- PingOne <br/>
412+
- JumpCloud <br/>
413+
- Rippling <br/>
414+
- OpenID <br/>
415+
- Generic SAML <br/>
416+
417+
Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the boxy hq server. If you are using our SuperTokens managed service, we will host the Boxy HQ server for you ([reach out to us](mailto:[email protected]) to activate your instance).
403418

404419

405420
:::success

0 commit comments

Comments
 (0)