Download OpenAPI specification:Download
Manage third-party service providers that can use Transmit Security as an Identity Provider
Create a SAML access-based service provider in a specific tenant.
{- "name": "My service provider",
- "description": "string",
}
{- "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 all SAML access-based service providers in a specific tenant
curl -i -X GET \ https://api.transmitsecurity.io/cis/v1/serviceprovider/saml2 \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "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"
}
]
}
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.
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/serviceprovider/saml2/sso/{serviceProviderId}?SAMLRequest=string&RelayState=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": {
- "SsoUrl": "string",
- "SAMLResponse": "string",
- "RelayState": "string"
}
}
Update the specified SAML service provider
{- "name": "My service provider",
- "description": "string",
}
{- "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 the specified SAML service provider
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/serviceprovider/saml2/{serviceProviderId}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "message": "Service provider does not exist in tenant",
- "error_code": 404
}