Skip to main content
POST
/
managed_accounts
/
{managed_account_token}
/
sso_connection
Configure SSO for managed account
curl --request POST \
  --url https://api.vantage.sh/v2/managed_accounts/{managed_account_token}/sso_connection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "saml",
  "saml_metadata_url": "<string>",
  "additional_domains": [
    "<string>"
  ]
}
'
{
  "token": "<string>",
  "name": "<string>",
  "contact_email": "<string>",
  "parent_account_token": "<string>",
  "access_credential_tokens": [
    "<string>"
  ],
  "billing_rule_tokens": [
    "<string>"
  ],
  "email_domain": "<string>",
  "msp_billing_profile_token": "<string>",
  "payment_terms_days": 123,
  "include_managed_account_integrations": true,
  "billing_information_attributes": {
    "token": "<string>",
    "company_name": "<string>",
    "country_code": "<string>",
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "billing_email": [
      "<string>"
    ]
  },
  "business_information_attributes": {
    "token": "<string>",
    "metadata": {
      "custom_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

managed_account_token
string
required

Body

application/json

Configure SSO for a Managed Account.

type
enum<string>
required

The type of SSO connection. Currently supported: saml.

Available options:
saml
saml_metadata_url
string

The SAML metadata URL for the identity provider. Required when type is saml.

additional_domains
string[]

Additional email domains to associate with this SSO configuration. The account's SSO domain is always included.

Response

ManagedAccount model

token
string
required
name
string
required
contact_email
string
required
parent_account_token
string
required

The token for the parent Account.

access_credential_tokens
string[]
required

The tokens for the Access Credentials assigned to the Managed Account.

billing_rule_tokens
string[]
required

The tokens for the Billing Rules assigned to the Managed Account.

email_domain
string | null

Email domain associated with this Managed Account for SSO.

msp_billing_profile_token
string | null

Token of the MSP billing profile used for this managed account (MSP invoicing accounts only)

payment_terms_days
integer<int32> | null

Number of days until payment is due after invoice date (MSP invoicing accounts only)

include_managed_account_integrations
boolean | null

Whether to include managed account's own integrations in invoice cost calculations (MSP invoicing accounts only)

billing_information_attributes
object
business_information_attributes
object