Skip to content
OpenBot

sso.listDomains

GET
/v1/organization/domains
curl --request GET \
  --url https://example.com/v1/organization/domains \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
items
required
Array<object>
object
domain
required
string
recordName
required
string
recordValue
required
string
verifiedAt
required
Any of:
string
createdAt
required
string

Example generated

{
  "items": [
    {
      "domain": "example",
      "recordName": "example",
      "recordValue": "example",
      "verifiedAt": "example",
      "createdAt": "example"
    }
  ]
}

400

Section titled “400”

SsoConnectionInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SsoConnectionInvalid
message
required
string

Example 

{
  "_tag": "SsoConnectionInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

404

Section titled “404”

DomainNotFound | SsoConnectionNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: DomainNotFound
domain
required
string

Example 

{
  "_tag": "DomainNotFound"
}

409

Section titled “409”

@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Pending
ticket
required
string
reason
string

Example 

{
  "_tag": "Pending"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

SsoUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PolicyUnavailable

Example 

{
  "_tag": "PolicyUnavailable"
}