Update organisation single sign-on policy
import requests
url = "https://api.platform.ankra.app/org/organisation/{organisation_id}/sso"
payload = {
"break_glass_user_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_enabled": True,
"jit_enabled": True,
"reverify_interval_hours": 360
}
headers = {
"cookie": "ankra_session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: 'ankra_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
break_glass_user_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_enabled: true,
jit_enabled: true,
reverify_interval_hours: 360
})
};
fetch('https://api.platform.ankra.app/org/organisation/{organisation_id}/sso', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://api.platform.ankra.app/org/organisation/{organisation_id}/sso \
--header 'Content-Type: application/json' \
--cookie ankra_session= \
--data '
{
"break_glass_user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_enabled": true,
"jit_enabled": true,
"reverify_interval_hours": 360
}
'{
"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
Update organisation single sign-on policy
Changes the single sign-on policy: whether it is enabled, whether it is required for members on the verified domains, just-in-time membership and its default role, the re-verification window after which a member the provider no longer vouches for is suspended, and the break-glass members who keep their other sign-in methods. Enabling needs a verified domain; requiring needs one successful single sign-on login first; the break-glass list can never be emptied.
PATCH
/
org
/
organisation
/
{organisation_id}
/
sso
Update organisation single sign-on policy
import requests
url = "https://api.platform.ankra.app/org/organisation/{organisation_id}/sso"
payload = {
"break_glass_user_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_enabled": True,
"jit_enabled": True,
"reverify_interval_hours": 360
}
headers = {
"cookie": "ankra_session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: 'ankra_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
break_glass_user_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_enabled: true,
jit_enabled: true,
reverify_interval_hours: 360
})
};
fetch('https://api.platform.ankra.app/org/organisation/{organisation_id}/sso', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://api.platform.ankra.app/org/organisation/{organisation_id}/sso \
--header 'Content-Type: application/json' \
--cookie ankra_session= \
--data '
{
"break_glass_user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_enabled": true,
"jit_enabled": true,
"reverify_interval_hours": 360
}
'{
"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
Body
application/json
Response
Single sign-on settings