Get Public Sector Security Settings
GET
/api/v1/sectors/{sectorID}/publicsettings
const url = 'https://api.spartanauth.com/api/v1/sectors/example/publicsettings';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.spartanauth.com/api/v1/sectors/example/publicsettingsReturns the public security settings for the given sector. This is an unauthenticated endpoint and only returns information needed to render the login page (e.g. whether MFA is required or self-signup is allowed), without exposing any sensitive settings or configuration.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” sectorID
required
string
Query Parameters
Section titled “Query Parameters ” name
string
domain
string
isDefault
boolean
allowedOrigins
Array<string>
slug
string
Responses
Section titled “ Responses ”A successful response.
Media type application/json
object
MFARequired
boolean
SelfSignUpAllowed
boolean
Example generated
{ "MFARequired": true, "SelfSignUpAllowed": true}default
Section titled “default ”An unexpected error response.
Media type application/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}