Remove a claimed email domain
import requests
url = "https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}"
headers = {"cookie": "ankra_session="}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {cookie: 'ankra_session='}};
fetch('https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request DELETE \
--url https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id} \
--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
Remove a claimed email domain
Removes a claimed domain. The last verified domain of an enabled connection cannot be removed, because every sign-in through the connection would then be refused.
DELETE
/
org
/
organisation
/
{organisation_id}
/
sso
/
domains
/
{domain_id}
Remove a claimed email domain
import requests
url = "https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}"
headers = {"cookie": "ankra_session="}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {cookie: 'ankra_session='}};
fetch('https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request DELETE \
--url https://platform.ankra.app/org/organisation/{organisation_id}/sso/domains/{domain_id} \
--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.