For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/organizations/get-a-saml-configuration.md. A documentation index is available at /llms.txt.

Get a SAML configuration

GET https://api.ap1.datadoghq.com/api/v2/saml_configurations/{saml_config_uuid}https://api.ap2.datadoghq.com/api/v2/saml_configurations/{saml_config_uuid}https://api.datadoghq.eu/api/v2/saml_configurations/{saml_config_uuid}https://api.ddog-gov.com/api/v2/saml_configurations/{saml_config_uuid}https://api.us2.ddog-gov.com/api/v2/saml_configurations/{saml_config_uuid}https://api.uk1.datadoghq.com/api/v2/saml_configurations/{saml_config_uuid}https://api.datadoghq.com/api/v2/saml_configurations/{saml_config_uuid}https://api.us3.datadoghq.com/api/v2/saml_configurations/{saml_config_uuid}https://api.us5.datadoghq.com/api/v2/saml_configurations/{saml_config_uuid}

Overview

Get a single SAML configuration for the current organization by its UUID. This endpoint requires the org_management permission.

Arguments

Path Parameters

Name

Type

Description

saml_config_uuid [required]

string

The UUID of the SAML configuration.

Response

OK

Response containing a single SAML configuration.

Expand All

Field

Type

Description

data [required]

object

A SAML configuration object.

attributes

object

Attributes of a SAML configuration.

assertion_consumer_service

[string]

The assertion consumer service (ACS) URLs that the identity provider posts SAML responses to.

created_at

date-time

Creation time of the SAML configuration.

entity_id

string

The service provider entity ID Datadog presents to the identity provider.

expires_at

date-time

Expiration time of the uploaded identity provider metadata.

idp_initiated

boolean

Whether identity-provider-initiated login is enabled for the organization.

jit_domains

[string]

Email domains for which users are automatically provisioned on first SAML login (just-in-time provisioning).

modified_at

date-time

Time of the last SAML configuration modification.

sso_url

string

The single sign-on URL users can visit to start a SAML login. Returns null when the organization is identity-provider-initiated and has no subdomain.

id [required]

string

The UUID of the SAML configuration.

relationships

object

Relationships of a SAML configuration.

default_roles

object

Relationship to roles.

data

[object]

An array containing type and the unique identifier of a role.

id

string

The unique identifier of the role.

type

enum

Roles type. Allowed enum values: roles

default: roles

type [required]

enum

SAML configurations resource type. Allowed enum values: saml_configurations

default: saml_configurations

included

[object]

Resources related to the SAML configuration, such as the default roles.

attributes

object

Attributes of the role.

created_at

date-time

Creation time of the role.

modified_at

date-time

Time of last role modification.

name

string

The name of the role. The name is neither unique nor a stable identifier of the role.

receives_permissions_from

[string]

The managed role from which this role automatically inherits new permissions. Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role.

user_count

int64

Number of users with that role.

id

string

The unique identifier of the role.

relationships

object

Relationships of the role object returned by the API.

permissions

object

Relationship to multiple permissions objects.

data

[object]

Relationships to permission objects.

id

string

ID of the permission.

type

enum

Permissions resource type. Allowed enum values: permissions

default: permissions

type [required]

enum

Roles type. Allowed enum values: roles

default: roles

{
  "data": {
    "attributes": {
      "assertion_consumer_service": [
        "https://app.datadoghq.com/account/saml/assertion"
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "entity_id": "https://app.datadoghq.com/account/saml/metadata.xml?id=00000000-0000-0000-0000-000000000000",
      "expires_at": "2010-10-26T13:31:15+00:00",
      "idp_initiated": true,
      "jit_domains": [
        "example.com"
      ],
      "modified_at": "2019-09-19T10:00:00.000Z",
      "sso_url": "https://app.datadoghq.com/account/login/id/00000000-0000-0000-0000-000000000000"
    },
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    "relationships": {
      "default_roles": {
        "data": [
          {
            "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
            "type": "roles"
          }
        ]
      }
    },
    "type": "saml_configurations"
  },
  "included": [
    {
      "attributes": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "modified_at": "2019-09-19T10:00:00.000Z",
        "name": "string",
        "receives_permissions_from": [],
        "user_count": "integer"
      },
      "id": "string",
      "relationships": {
        "permissions": {
          "data": [
            {
              "id": "string",
              "type": "permissions"
            }
          ]
        }
      },
      "type": "roles"
    }
  ]
}

Authentication Error

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export saml_config_uuid="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/saml_configurations/${saml_config_uuid}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a SAML configuration returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.organizations_api import OrganizationsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = OrganizationsApi(api_client)
    response = api_instance.get_saml_configuration(
        saml_config_uuid="3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Get a SAML configuration returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OrganizationsAPI.new
p api_instance.get_saml_configuration("3653d3c6-0c75-11ea-ad28-fb5701eabc7d")

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Get a SAML configuration returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewOrganizationsApi(apiClient)
	resp, r, err := api.GetSAMLConfiguration(ctx, "3653d3c6-0c75-11ea-ad28-fb5701eabc7d")

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.GetSAMLConfiguration`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.GetSAMLConfiguration`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Get a SAML configuration returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OrganizationsApi;
import com.datadog.api.client.v2.model.SAMLConfigurationResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);

    try {
      SAMLConfigurationResponse result =
          apiInstance.getSAMLConfiguration("3653d3c6-0c75-11ea-ad28-fb5701eabc7d");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#getSAMLConfiguration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Get a SAML configuration returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_organizations::OrganizationsAPI;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = OrganizationsAPI::with_config(configuration);
    let resp = api
        .get_saml_configuration("3653d3c6-0c75-11ea-ad28-fb5701eabc7d".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Get a SAML configuration returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.OrganizationsApi(configuration);

const params: v2.OrganizationsApiGetSAMLConfigurationRequest = {
  samlConfigUuid: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
};

apiInstance
  .getSAMLConfiguration(params)
  .then((data: v2.SAMLConfigurationResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"