Create SAML Connection | SSOReady Docs

Creates a SAML connection.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

idstringOptional

Unique identifier for this SAML connection.

organizationIdstringOptional

The organization this SAML connection belongs to.

primarybooleanOptional

Whether this is the primary SAML connection for the organization.

idpRedirectUrlstringOptional

URL to redirect to when initiating SAML flows. IDP redirect URLs are assigned by an Identity Provider, and need to be inputted into SSOReady.

idpCertificatestringOptional

Certificate to authenticate SAML assertions. This is a PEM-encoded X.509 certificate.

IDP certificates are assigned by an Identity Provider, and need to be inputted into SSOReady.

idpEntityIdstringOptional

Identifier for the identity provider when handling SAML operations. IDP entity IDs are assigned by an Identity Provider, and need to be inputted into SSOReady.

spEntityIdstringOptional

Identifier for the SAML connection when handling SAML operations. SP entity IDs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.

spAcsUrlstringOptional

URL the Identity Provider redirects to when transmitting SAML assertions. Stands for "Service Provider Assertion Consumer Service" URL. SP ACS URLs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.

Response

samlConnectionobject

The created SAML connection.

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

Unique identifier for this SAML connection.

The organization this SAML connection belongs to.

Whether this is the primary SAML connection for the organization.

URL to redirect to when initiating SAML flows. IDP redirect URLs are assigned by an Identity Provider, and need to be inputted into SSOReady.

Certificate to authenticate SAML assertions. This is a PEM-encoded X.509 certificate.

IDP certificates are assigned by an Identity Provider, and need to be inputted into SSOReady.

Identifier for the identity provider when handling SAML operations. IDP entity IDs are assigned by an Identity Provider, and need to be inputted into SSOReady.

Identifier for the SAML connection when handling SAML operations. SP entity IDs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.

The created SAML connection.

$	curl -X POST https://api.ssoready.com/v1/saml-connections \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"samlConnection": {
3	"id": "id",
4	"organizationId": "organizationId",
5	"primary": true,
6	"idpRedirectUrl": "idpRedirectUrl",
7	"idpCertificate": "idpCertificate",
8	"idpEntityId": "idpEntityId",
9	"spEntityId": "spEntityId",
10	"spAcsUrl": "spAcsUrl"
11	}
12	}

$	curl -X POST https://api.ssoready.com/v1/saml-connections \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"samlConnection": {
3	"id": "id",
4	"organizationId": "organizationId",
5	"primary": true,
6	"idpRedirectUrl": "idpRedirectUrl",
7	"idpCertificate": "idpCertificate",
8	"idpEntityId": "idpEntityId",
9	"spEntityId": "spEntityId",
10	"spAcsUrl": "spAcsUrl"
11	}
12	}