Verify a claimed email domain by its DNS record
import requests
url = "https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}/verify"
headers = {"cookie": "ankra_session="}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {cookie: 'ankra_session='}};
fetch('https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}/verify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}/verify \
--cookie ankra_session={
"connection": {
"break_glass_user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"client_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"enforcement": "optional",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_enabled": true,
"issuer": "<string>",
"jit_default_role": "member",
"jit_enabled": true,
"last_login_at": "2023-11-07T05:31:56Z",
"reverify_interval_hours": 360,
"strategy": "oidc",
"updated_at": "2023-11-07T05:31:56Z"
},
"domains": [
{
"domain": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_verified": true,
"last_checked_at": "2023-11-07T05:31:56Z",
"verification_record_name": "<string>",
"verification_record_value": "<string>",
"verified_at": "2023-11-07T05:31:56Z"
}
],
"group_mappings": [
{
"group": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "member"
}
],
"governed_member_count": 123,
"is_available": true,
"redirect_uri": "<string>",
"sign_in_url": "<string>",
"suspended_member_count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Organisation
Verify a claimed email domain by its DNS record
Looks up the domain’s challenge record and marks the domain verified when the record is published. Until then the answer is 422 with the record to publish; DNS changes can take a few minutes to appear.
POST
/
org
/
organisation
/
{organisation_id}
/
sso
/
domains
/
{domain_id}
/
verify
Verify a claimed email domain by its DNS record
import requests
url = "https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}/verify"
headers = {"cookie": "ankra_session="}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {cookie: 'ankra_session='}};
fetch('https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}/verify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}/verify \
--cookie ankra_session={
"connection": {
"break_glass_user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"client_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"enforcement": "optional",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_enabled": true,
"issuer": "<string>",
"jit_default_role": "member",
"jit_enabled": true,
"last_login_at": "2023-11-07T05:31:56Z",
"reverify_interval_hours": 360,
"strategy": "oidc",
"updated_at": "2023-11-07T05:31:56Z"
},
"domains": [
{
"domain": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_verified": true,
"last_checked_at": "2023-11-07T05:31:56Z",
"verification_record_name": "<string>",
"verification_record_value": "<string>",
"verified_at": "2023-11-07T05:31:56Z"
}
],
"group_mappings": [
{
"group": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "member"
}
],
"governed_member_count": 123,
"is_available": true,
"redirect_uri": "<string>",
"sign_in_url": "<string>",
"suspended_member_count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Browser session. Mutations also require X-Ankra-CSRF.
Response
Single sign-on settings
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Sends somebody straight to the organisation's identity provider. Served on the portal origin, which proxies /auth/* to the API; null until a domain is verified.