Service Providers

Manage third-party service providers that can use Transmit Security as an Identity Provider

Download OpenAPI description

service-providers.openapi.json

service-providers.openapi.yaml

Servers

Sandbox environment

https://api.sbx.transmitsecurity.io/cis/

Production environment (US)

https://api.transmitsecurity.io/cis/

Production environment (EU)

https://api.eu.transmitsecurity.io/cis/

Production environment (CA)

https://api.ca.transmitsecurity.io/cis/

Production environment (AU)

https://api.au.transmitsecurity.io/cis/

Create SAML provider

Request

Create a SAML access-based service provider in a specific tenant.

Required permissions: service-providers:create, apps:create, [appId]:create.

Security

ClientAccessToken

Bodyapplication/jsonrequired

namestringrequired

Name of the service provider

Example: "My service provider"

descriptionstring

Short description of the service provider

assertion_consumer_service_URLstringrequired

Assertion consumer service URL, which receives the SAML response

Example: "https://example.com/sso/saml"

entity_idstringrequired

Entity ID (Also referred to as Audience)

Example: "https://example.com"

name_qualifierstring

Name Qualifier

Example: "https://yourdomain.example.com/"

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/serviceprovider/saml2 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My service provider",
    "description": "string",
    "assertion_consumer_service_URL": "https://example.com/sso/saml",
    "entity_id": "https://example.com",
    "name_qualifier": "https://yourdomain.example.com/"
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.service_provider_idstringrequired

Service provider ID autogenerated upon creation

result.tenant_idstringrequired

Transmit tenant ID

result.namestringrequired

Service provider friendly name

result.descriptionstring

Service provider description

result.assertion_consumer_service_URLstringrequired

Assertion consumer service URL, which receives the SAML response

result.entity_idstringrequired

Entity ID (Also referred to as Audience)

result.name_qualifierstring

Name Qualifier

result.saml_urlstring

Transmit's SAML SSO endpoint that receives authentication requests

result.issuerstring

Identifies Transmit as the issuer of the SAML response

result.pub_certstring

X.509 certificate containing Transmit's public key, used to validate the signed SAML assertion

Response

application/json

{
  "result": {
    "service_provider_id": "string",
    "tenant_id": "string",
    "name": "string",
    "description": "string",
    "assertion_consumer_service_URL": "string",
    "entity_id": "string",
    "name_qualifier": "string",
    "saml_url": "string",
    "issuer": "string",
    "pub_cert": "string"
  }
}

Get SAML providers

Request

Get all SAML access-based service providers in a specific tenant.

Required permissions: service-providers:list, service-providers:read, apps:list, [appId]:list, apps:read, [appId]:read.

Security

ClientAccessToken

curl -i -X GET \
  https://api.sbx.transmitsecurity.io/cis/v1/serviceprovider/saml2 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].service_provider_idstringrequired

Service provider ID autogenerated upon creation

result[].tenant_idstringrequired

Transmit tenant ID

result[].namestringrequired

Service provider friendly name

result[].descriptionstring

Service provider description

result[].assertion_consumer_service_URLstringrequired

Assertion consumer service URL, which receives the SAML response

result[].entity_idstringrequired

Entity ID (Also referred to as Audience)

result[].name_qualifierstring

Name Qualifier

result[].saml_urlstring

Transmit's SAML SSO endpoint that receives authentication requests

result[].issuerstring

Identifies Transmit as the issuer of the SAML response

result[].pub_certstring

X.509 certificate containing Transmit's public key, used to validate the signed SAML assertion

Response

application/json

{
  "result": [
    { … }
  ]
}

Update SAML provider

Request

Update the specified SAML service provider.

Required permissions: service-providers:edit, apps:edit, [appId]:edit.

Security

ClientAccessToken

Path

serviceProviderIdstringrequired

Bodyapplication/jsonrequired

namestring

Name of the service provider

Example: "My service provider"

descriptionstring

Short description of the service provider

assertion_consumer_service_URLstring

Assertion consumer service URL, which receives the SAML response

Example: "https://example.com/sso/saml"

entity_idstring

Entity ID (Also referred to as Audience)

Example: "https://example.com"

name_qualifierstring

Name Qualifier

Example: "https://yourdomain.example.com/"

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/serviceprovider/saml2/{serviceProviderId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My service provider",
    "description": "string",
    "assertion_consumer_service_URL": "https://example.com/sso/saml",
    "entity_id": "https://example.com",
    "name_qualifier": "https://yourdomain.example.com/"
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.service_provider_idstringrequired

Service provider ID autogenerated upon creation

result.tenant_idstringrequired

Transmit tenant ID

result.namestringrequired

Service provider friendly name

result.descriptionstring

Service provider description

result.assertion_consumer_service_URLstringrequired

Assertion consumer service URL, which receives the SAML response

result.entity_idstringrequired

Entity ID (Also referred to as Audience)

result.name_qualifierstring

Name Qualifier

result.saml_urlstring

Transmit's SAML SSO endpoint that receives authentication requests

result.issuerstring

Identifies Transmit as the issuer of the SAML response

result.pub_certstring

X.509 certificate containing Transmit's public key, used to validate the signed SAML assertion

Response

application/json

{
  "result": {
    "service_provider_id": "string",
    "tenant_id": "string",
    "name": "string",
    "description": "string",
    "assertion_consumer_service_URL": "string",
    "entity_id": "string",
    "name_qualifier": "string",
    "saml_url": "string",
    "issuer": "string",
    "pub_cert": "string"
  }
}

Delete SAML provider

Request

Delete the specified SAML service provider.

Required permissions: service-providers:delete, apps:delete, [appId]:delete.

Security

ClientAccessToken

Path

serviceProviderIdstringrequired

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/serviceprovider/saml2/{serviceProviderId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

SAML SSO

Request

Exchanges a user access token for a SAML response, used to perform an SSO login into a SAML service provider. The user access token, retrieved via a successful login with Transmit, is used to authorize this request.

Security

UserAccessToken

Path

serviceProviderIdstringrequired

Query

SAMLRequeststring

SAMLRequest

RelayStatestring

RelayState

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/serviceprovider/saml2/sso/{serviceProviderId}?SAMLRequest=string&RelayState=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

result.SsoUrlstringrequired

result.SAMLResponsestringrequired

result.RelayStatestringrequired

Response

application/json

{
  "result": {
    "SsoUrl": "string",
    "SAMLResponse": "string",
    "RelayState": "string"
  }
}