{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"REST API for Identity Federation","description":"API reference for Treasure Data Identity Federation. Configure SSO settings, create users with SSO, and manage identity provider integrations.","siteUrl":"https://docs.treasuredata.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"rest-api-for-identity-federation","__idx":0},"children":["REST API for Identity Federation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Treasure Data uses the same API endpoints for all our Identity Providers. You can set different values in your payload body to specify the needs of your IdP, including your identity provider name, sign-in and sign-out endpoints, or certification of IdP."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This reference contains APIs for various operations, including getting, creating, editing, deleting configurations for SSO and user settings."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"v3-sso-settings","__idx":1},"children":["V3 SSO Settings"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-v3accountsso_setting","__idx":2},"children":["GET /v3/account/sso_setting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get SSO settings."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/account/sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gets account settings for their SSO configuration."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An SSO setting"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request GET \\\n  --location 'https://api.treasuredata.com/v3/account/sso_setting' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"sso_setting\": {\n    \"cert\": \"-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----\",\n    \"identity_provider_name\": \"AzureAD\",\n    \"sign_in_endpoint\": \"https://login.example.com/ffffffff-ffff-ffff-ffff-ffffffffffff/saml\",\n    \"sign_out_endpoint\": \"https://login.example.com/signout\",\n    \"strategy\": \"samlp\",\n    \"updated_at\": \"2020-12-31T11:22:33.000Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-v3accountsso_setting","__idx":3},"children":["POST /v3/account/sso_setting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new SSO setting."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/account/sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows admin to create and configure IdP for an account."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An SSO setting"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request POST \\\n  --location 'https://api.treasuredata.com/v3/account/sso_setting' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>' \\\n  --data-raw '{\n    \"sso_setting\": {\n        \"sign_in_endpoint\": \"urn:treasuredata:sso:eu01:1\",\n        \"sign_out_endpoint\": null,\n        \"cert\": \"-----BEGIN CERTIFICATE-----xxxxx-----END CERTIFICATE-----\"\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"sso_setting\": {\n    \"cert\": \"-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----\",\n    \"identity_provider_name\": \"AzureAD\",\n    \"sign_in_endpoint\": \"https://login.example.com/ffffffff-ffff-ffff-ffff-ffffffffffff/saml\",\n    \"sign_out_endpoint\": \"https://login.example.com/signout\",\n    \"strategy\": \"samlp\",\n    \"updated_at\": \"2020-12-31T11:22:33.000Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"put-v3accountsso_setting","__idx":4},"children":["PUT /v3/account/sso_setting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates to an IdP account setting."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/account/sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows admin to make updates to an IdP account setting."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An SSO setting"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request PUT \\\n  --location 'https://api.treasuredata.com/v3/account/sso_setting' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>' \\\n  --data-raw '{\n    \"sso_setting\": {\n        \"sign_in_endpoint\": \"urn:treasuredata:sso:eu01:1\",\n        \"sign_out_endpoint\": null,\n        \"cert\": \"-----BEGIN CERTIFICATE-----xxxxx-----END CERTIFICATE-----\"\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"sso_setting\": {\n    \"cert\": \"-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----\",\n    \"identity_provider_name\": \"AzureAD\",\n    \"sign_in_endpoint\": \"https://login.example.com/ffffffff-ffff-ffff-ffff-ffffffffffff/saml\",\n    \"sign_out_endpoint\": \"https://login.example.com/signout\",\n    \"strategy\": \"samlp\",\n    \"updated_at\": \"2020-12-31T11:22:33.000Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-v3accountsso_setting","__idx":5},"children":["DELETE /v3/account/sso_setting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delete an IdP account setting."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/account/sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows admin to delete an IdP account setting."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso_setting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An SSO setting"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request DELETE \\\n  --location 'https://api.treasuredata.com/v3/account/sso_setting' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"v3-user-settings","__idx":6},"children":["V3 User Settings"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-v3usercreate_with_ssouser_first_name","__idx":7},"children":["POST /v3/user/create_with_sso/:user_first_name"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a user with SSO."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/create_with_sso/:user_first_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows the admin to create a user with SSO."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_first_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name of user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email user uses to log in"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SSO identifier from IdP"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request POST \\\n  --location 'https://api.treasuredata.com/v3/user/create_with_sso/:user_first_name' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>' \\\n  --data-raw '{\n    \"email\": \"jake@companyName.com\",\n    \"identifier\": \"employee_number-00001\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"first_name\": \"Jake\",\n  \"email\": \"jake@companyName.com\",\n  \"identifier\": \"employee_number-00001\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-v3userenforce_ssouser_email","__idx":8},"children":["POST /v3/user/enforce_sso/:user_email"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enforces SSO."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/enforce_sso/:user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows admin to make it mandatory for a user to login with SSO."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email of the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SSO identifier from IdP"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request POST \\\n  --location 'https://api.treasuredata.com/v3/user/enforce_sso/:user_email' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>' \\\n  --data-raw '{\n    \"sso_setting\": {\n        \"user_email\": \"user_email\",\n        \"identifier\": \"12345678\"\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"email\": \"jake@companyName.com\",\n  \"identifier\": \"employee_number-00001\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-v3userenable_ssouser_email","__idx":9},"children":["POST /v3/user/enable_sso/:user_email"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enables SSO for a user."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/enable_sso/:user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows admin to permit a user to login with SSO."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email of the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SSO identifier from IdP"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request POST \\\n  --location 'https://api.treasuredata.com/v3/user/enable_sso/:user_email' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>' \\\n  --data-raw '{\n    \"sso_setting\": {\n        \"user_email\": \"user_email\",\n        \"identifier\": \"12345678\"\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"email\": \"jake@companyName.com\",\n  \"identifier\": \"employee_number-00001\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-v3userdisable_ssouser_email","__idx":10},"children":["POST /v3/user/disable_sso/:user_email"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Disables SSO for a user."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/disable_sso/:user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows admin to prohibit a user from logging in with SSO."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email of the user"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --request POST \\\n  --location 'https://api.treasuredata.com/v3/user/disable_sso/:user_email' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Authorization: TD1 <td_api_token>' \\\n  --data-raw '{\n    \"sso_setting\": {\n        \"user_email\": \"user_email\"\n    }\n}'\n","lang":"bash"},"children":[]}]},"headings":[{"value":"REST API for Identity Federation","id":"rest-api-for-identity-federation","depth":1},{"value":"V3 SSO Settings","id":"v3-sso-settings","depth":2},{"value":"GET /v3/account/sso_setting","id":"get-v3accountsso_setting","depth":3},{"value":"POST /v3/account/sso_setting","id":"post-v3accountsso_setting","depth":3},{"value":"PUT /v3/account/sso_setting","id":"put-v3accountsso_setting","depth":3},{"value":"DELETE /v3/account/sso_setting","id":"delete-v3accountsso_setting","depth":3},{"value":"V3 User Settings","id":"v3-user-settings","depth":2},{"value":"POST /v3/user/create_with_sso/:user_first_name","id":"post-v3usercreate_with_ssouser_first_name","depth":3},{"value":"POST /v3/user/enforce_sso/:user_email","id":"post-v3userenforce_ssouser_email","depth":3},{"value":"POST /v3/user/enable_sso/:user_email","id":"post-v3userenable_ssouser_email","depth":3},{"value":"POST /v3/user/disable_sso/:user_email","id":"post-v3userdisable_ssouser_email","depth":3}],"frontmatter":{"seo":{"title":"REST API for Identity Federation","description":"API reference for Treasure Data Identity Federation. Configure SSO settings, create users with SSO, and manage identity provider integrations."}},"lastModified":"2026-02-17T14:14:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/td-api/identity-federation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}