Get a SAML service provider certificate (Beta)

GET

/v2/saml/service-providers/:samlServiceProviderId/certificates/:samlServiceProviderCertificateId

GET

/v2/saml/service-providers/:samlServiceProviderId/certificates/:samlServiceProviderCertificateId

$ curl https://api.sigmacomputing.com/v2/saml/service-providers/samlServiceProviderId/certificates/samlServiceProviderCertificateId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "samlServiceProviderCertificateId": "cert-9f8b7c6d-1234-4a56-b789-0cdef1234567",
3   "samlServiceProviderId": "sp-4a3b2c1d-5678-4e90-8f12-3456789abcde",
4   "purpose": "signing",
5   "publicKeyCertificate": "-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgIEb1Zk1zANBgkqhkiG9w0BAQsFADBvMQswCQYDVQQGEwJV\nUzELMAkGA1UECAwCQ0ExEDAOBgNVBAcMB1NhbiBKb3NlMRMwEQYDVQQKDApFeGFt\ncGxlIEluYzEZMBcGA1UECwwQRXhhbXBsZSBEZXBhcnRtZW50MRQwEgYDVQQDDAtl\nbmNyeXB0LmNvbTAeFw0yNDAxMTUxMDMwMDBaFw0yNTAxMTUxMDMwMDBaMG8xCzAJ\nBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEQMA4GA1UEBwwHU2FuIEpvc2UxEzARBgNV\nBAoMCkV4YW1wbGUgSW5jMRkwFwYDVQQLDBBFeGFtcGxlIERlcGFydG1lbnQxFDAS\nBgNVBAMMC2VuY3J5cHQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC\nAQEAtV6Xq6Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v7Xq1v\n-----END CERTIFICATE-----",
6   "isActive": true,
7   "notBefore": "2024-01-15T09:30:00Z",
8   "notAfter": "2026-01-15T09:30:00Z",
9   "createdAt": "2024-01-10T14:22:00Z",
10   "createdBy": "admin-user-1234",
11   "updatedAt": "2024-04-01T11:15:00Z",
12   "updatedBy": "admin-user-5678"
13 }

Get a certificate to use with your IdP when configuring Sigma as a service provider.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
Retrieve the samlServiceProviderId by calling the /saml/service-providers endpoint.
Retrieve the samlServiceProviderCertificateId by calling the /saml/service-providers/certificates endpoint.
Signing certificates are used by your IdP to verify signatures that Sigma attaches to SAML requests.
Encryption certificates are used by your IdP to encrypt SAML responses sent to Sigma.

Get a certificate to use with your IdP when configuring Sigma as a service provider. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint. - Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](https://help.sigmacomputing.com/reference/list-saml-service-provider-certificates) endpoint. - Signing certificates are used by your IdP to verify signatures that Sigma attaches to SAML requests. - Encryption certificates are used by your IdP to encrypt SAML responses sent to Sigma.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

samlServiceProviderIdstringRequired

samlServiceProviderCertificateIdstringRequired

Response

The response body.

samlServiceProviderCertificateIdstring

Unique identifier of the SAML service provider certificate

samlServiceProviderIdstring

Unique identifier of the SAML service provider

purposeenum

Purpose of the certificate. Use signing for signing SAML requests and encryption for encrypting SAML responses.

publicKeyCertificatestring

PEM-encoded X.509 certificate

isActiveboolean

Whether the certificate is currently active

notBeforedatetime

Date and time when the certificate becomes valid

notAfterdatetime

Date and time when the certificate expires

createdAtdatetime

When the certificate was created

createdBystring

Identifier of the user who created the certificate

updatedAtdatetime

When the certificate was last updated

updatedBystring

Identifier of the user who last updated the certificate