Get SSO partner for a domain

ApiScope: manage.sso.partner.read
API Scope Level: ServiceSubscriberScope

Query Parameters

domain string

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

application/x-protobuf

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
ssoPartner object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
domains object[]
Array [
name string
description string
uuid string
ssoPartnerDTO object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "ssoPartner": {
    "name": "string",
    "type": "SAML_20",
    "description": "string",
    "uuid": "string",
    "attributes": {},
    "domains": [
      {
        "name": "string",
        "description": "string",
        "uuid": "string",
        "ssoPartnerDTO": {
          "name": "string",
          "type": "SAML_20",
          "description": "string",
          "uuid": "string",
          "attributes": {}
        }
      }
    ]
  }
}

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
ssoPartner object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
domains object[]
Array [
name string
description string
uuid string
ssoPartnerDTO object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "ssoPartner": {
    "name": "string",
    "type": "SAML_20",
    "description": "string",
    "uuid": "string",
    "attributes": {},
    "domains": [
      {
        "name": "string",
        "description": "string",
        "uuid": "string",
        "ssoPartnerDTO": {
          "name": "string",
          "type": "SAML_20",
          "description": "string",
          "uuid": "string",
          "attributes": {}
        }
      }
    ]
  }
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

GET /v2/ssopartner

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

domain — query

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/manage/v2/ssopartner' \
-H 'Accept: application/json'