Service Providers

Download OpenAPI specification:Download

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

Create SAML provider

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

SecurityHTTP: bearer
Request
Request Body schema: application/json
required
name
required
string

Name of the service provider

description
string

Short description of the service provider

assertion_consumer_service_URL
required
string

Assertion consumer service URL, which receives the SAML response

entity_id
required
string

Entity ID (Also referred to as Audience)

name_qualifier
string

Name Qualifier

Responses
201
400
post/v1/serviceprovider/saml2
Request samples
application/json
{}
Response samples
application/json
{
  • "result": {
    }
}

Get SAML providers

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

SecurityHTTP: bearer
Responses
200
get/v1/serviceprovider/saml2
Request samples 
Response samples 
application/json
{
  • "result": [
    ]
}
Update SAML provider
Update the specified SAML service provider


SecurityHTTP: bearer 
Request 
path Parameters
serviceProviderId
required
string
 
Request Body schema: application/json
required
name
string
Name of the service provider


 
description
string
Short description of the service provider


 
assertion_consumer_service_URL
string
Assertion consumer service URL, which receives the SAML response


 
entity_id
string
Entity ID (Also referred to as Audience)


 
name_qualifier
string
Name Qualifier


 
Responses 
200
400
404
put/v1/serviceprovider/saml2/{serviceProviderId}
Request samples 
application/json
{}
Response samples 
application/json
{
  • "result": {
    }
}
Delete SAML provider
Delete the specified SAML service provider


SecurityHTTP: bearer 
Request 
path Parameters
serviceProviderId
required
string
 
Responses 
204
404
409
delete/v1/serviceprovider/saml2/{serviceProviderId}
Request samples 
Response samples 
application/json
{
  • "message": "Service provider does not exist in tenant",
  • "error_code": 404
}
SAML SSO
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.


SecurityHTTP: bearer 
Request 
path Parameters
serviceProviderId
required
string
 
query Parameters
SAMLRequest
string
SAMLRequest


 
RelayState
string
RelayState


 
Responses 
201
400
get/v1/serviceprovider/saml2/sso/{serviceProviderId}
Request samples 
Response samples 
application/json
{
  • "result": {
    }
}