SIsigmacomputing
SAML

Get a SAML service provider certificate (Beta)

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/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

samlServiceProviderIdstring required

Unique identifier of the SAML service provider

samlServiceProviderCertificateIdstring required

Unique identifier of the SAML service provider certificate

Response

The response body.

samlServiceProviderCertificateIdstring required

Unique identifier of the SAML service provider certificate

samlServiceProviderIdstring required

Unique identifier of the SAML service provider

purpose'signing' | 'encryption' required

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

publicKeyCertificatestring required

PEM-encoded X.509 certificate

isActiveboolean required

Whether the certificate is currently active

notBeforestring date-time required

Date and time when the certificate becomes valid

notAfterstring date-time required

Date and time when the certificate expires

createdAtstring date-time required

When the certificate was created

createdBystring required

Identifier of the user who created the certificate

updatedAtstring date-time required

When the certificate was last updated

updatedBystring required

Identifier of the user who last updated the certificate

Changes

No recorded changes to this operation across all 1 revision of this API.