SSO Integrations

Set up and oversee Single Sign-On integrations through OpenID Connect and SAML protocols.

GET Organization SSO Profile

Retrieve the Single Sign-On configuration details for an organization.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

get/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/sso_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"sso_provider_name_saml": "<string>",
"sso_provider_logo_saml": "<string>",
"sso_provider_name_openid": "<string>",
"sso_provider_logo_openid": "<string>",
"sso_auth_secret": "<string>",
"sso_auth_secret_validity": "<string>",
"sso_redirect_details_saml": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"sso_redirect_details_openid": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"created": "<string>",
"updated": "<string>"
}
}

Update Organization SSO Profile

Modify and enhance the organization's Single Sign-On settings to ensure secure and seamless user authentication.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

patch/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/sso_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"sso_provider_name_saml": "<string>",
"sso_provider_logo_saml": "<string>",
"sso_provider_name_openid": "<string>",
"sso_provider_logo_openid": "<string>",
"sso_redirect_details_saml": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"sso_redirect_details_openid": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"created": "<string>",
"updated": "<string>"
}
}

Get Organization SSO OpenID Profile

Retrieve the Single Sign-On (SSO) OpenID profile details for your organization.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

get/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/openid_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"openid_idp_endpoint": "<string>",
"openid_idp_details": { },
"openid_client_details": { },
"created": "<string>",
"updated": "<string>"
}
}

Update Organization SSO OpenID Profile

Modify the organization's Single Sign-On settings using OpenID to ensure secure and seamless user authentication.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/openid_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"openid_idp_endpoint": "<string>",
"openid_idp_details": { },
"openid_client_details": { },
"created": "<string>",
"updated": "<string>"
}
}

Get Organization SSO SAML Profile

Retrieve the SSO SAML profile settings for your organization to configure and manage secure authentication.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

get/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/saml_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"idp_metadata_link": "<string>",
"idp_metadata": "<string>",
"entity_id": "<string>",
"sp_metadata_link": "<string>",
"created": "<string>",
"updated": "<string>"
}
}

Update Organization SSO SAML Profile

Modify and enhance the Single Sign-On SAML profile settings for your organization to ensure secure and efficient authentication.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Accept

string

Example: application/json

Request Body schema: multipart/form-data

type	string option:file,link
xmlfile	string <binary> if select file then enable the xmlfile
xmllink	string if select link then enable the xmllink

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/saml_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"idp_metadata_link": "<string>",
"idp_metadata": "<string>",
"entity_id": "<string>",
"sp_metadata_link": "<string>",
"created": "<string>",
"updated": "<string>"
}
}