Details whether an authentication service has been configured properly

v1.0.0

Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator.

Supported Authenticators:

Azure
OIDC

Not Supported:

AWS IAM
Kubernetes
LDAP

See for details on setting up the authenticator status webservice.

Input

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    },
    "authenticator": {
      "type": "string"
    },
    "service_id": {
      "type": "string"
    }
  },
  "required": [
    "account",
    "authenticator",
    "service_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "error": {
      "type": "string",
      "description": "The error message if there was an error"
    },
    "status": {
      "type": "string",
      "description": "The status of the endpoint, 'error' if there was an error"
    }
  }
}