Powered by Redocly

Conditional Access

Conditional Access enforces security policies based on user context, such as location and device status, to regulate access to organizational resources. This dynamic approach enhances security while providing flexibility in user authentication and access control.

Conditional Access Start

Begin configuring and implementing conditional access policies to control user access based on specified conditions and criteria.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

405

Method Not Allowed

post/unifed-auth-service/unifed/{tenant_id}/magic/auth/start/conditional/access

Request samples

Response samples

200
400
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"uri": "uri to redirect"
}
}

Conditional Access Start

Begin configuring and implementing conditional access policies to control user access based on specified conditions and criteria.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

query Parameters

email

string

Example: email=<email>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Responses

200

OK

400

Bad Request

405

Method Not Allowed

get/unifed-auth-service/unifed/{tenant_id}/magic/auth/start/conditional/access

Request samples

Response samples

200
400
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"uri": "uri to redirect"
}
}

Get Conditional Access Settings

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

query Parameters

tenant_id

string

(Required)

Example: tenant_id=<tenant_id>

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

get/unifed-log-service/loganalyzer/v1/{tenant_id}/access/application/preference

Request samples

Response samples

200
400
401

application/json

{"enabled": true,
"tenant_id": "string",
"enable_ip_check": false,
"ip_address": ["127.0.0.1",
"128.0.0.1"
],
"exclusion_ip_users": ["email",
"email"
],
"enable_geolocation_check": false,
"latLong": [{"lat": 0,
"long": 0,
"radius": 2000,
"label": "<string>"
},
{"lat": 0,
"long": 0,
"radius": 2000,
"label": "<string>"
}
],
"location": [{"country": "India",
"state": ["Tamilnadu",
"Kerala"
]
}
],
"exclusion_geolocation_users": ["email",
"email"
],
"enforce_captcha": false,
"enable_deviceid_check": false,
"whitelisted_deviceids": ["string",
"string"
],
"brute_force_login": false,
"max_login_attempts": 0,
"max_login_attempts_duration": 0,
"max_login_attempts_duration_in": "hours",
"max_failure_login_attempts": 0,
"max_failure_login_attempts_duration": 0,
"max_failure_login_attempts_duration_in": "days",
"max_login_throttling_rates": 0,
"max_login_throttling_rates_duration": 0,
"max_login_throttling_rates_duration_in": "weeks",
"max_signup_throttling_rates": 0,
"max_signup_throttling_rates_duration": 0,
"max_signup_throttling_rates_duration_in": "minutes",
"account_lockout_duration": 0,
"account_lockout_duration_in": "months",
"account_lockout_login_notify_user": false,
"account_lockout_signup_notify_user": false,
"redirect_id": "<string>",
"logout_redirect_id": "<string>",
"redirect_details": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"logout_redirect_details": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"conditionalaccess_auth_secret": "string",
"conditionalaccess_auth_secret_validity": "<string>"
}

Conditonal Access Settings Update

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

put/unifed-log-service/loganalyzer/v1/{tenant_id}/access/application/preference

Request samples

Response samples

200
400
401

application/json

{"status": "<boolean>",
"message": "<string>",
"data": {"enabled": true,
"tenant_id": "string",
"enable_ip_check": false,
"ip_address": ["127.0.0.1",
"128.0.0.1"
],
"exclusion_ip_users": ["email",
"email"
],
"enable_geolocation_check": false,
"latLong": [{"lat": 0,
"long": 0,
"radius": 2000,
"label": "<string>"
},
{"lat": 0,
"long": 0,
"radius": 2000,
"label": "<string>"
}
],
"location": [{"country": "India",
"state": ["Tamilnadu",
"Kerala"
]
}
],
"exclusion_geolocation_users": ["email",
"email"
],
"enforce_captcha": false,
"enable_deviceid_check": false,
"whitelisted_deviceids": ["string",
"string"
],
"brute_force_login": false,
"max_login_attempts": 0,
"max_login_attempts_duration": 0,
"max_login_attempts_duration_in": "hours",
"max_failure_login_attempts": 0,
"max_failure_login_attempts_duration": 0,
"max_failure_login_attempts_duration_in": "days",
"max_login_throttling_rates": 0,
"max_login_throttling_rates_duration": 0,
"max_login_throttling_rates_duration_in": "weeks",
"max_signup_throttling_rates": 0,
"max_signup_throttling_rates_duration": 0,
"max_signup_throttling_rates_duration_in": "minutes",
"account_lockout_duration": 0,
"account_lockout_duration_in": "months",
"account_lockout_login_notify_user": false,
"account_lockout_signup_notify_user": false,
"redirect_id": "<string>",
"logout_redirect_id": "<string>",
"redirect_details": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"logout_redirect_details": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"conditionalaccess_auth_secret": "string",
"conditionalaccess_auth_secret_validity": "<string>"
}
}

➔ Next to DeviceID Access