openapi-directory/api/authentiq.io.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://connect.authentiq.io"}],"info":{"contact":{"email":"hello@authentiq.com","name":"Team Authentiq","url":"https://www.authentiq.com/"},"description":"Authentiq Connect OAuth 2.0 and OpenID Connect API reference.\nLearn about [Authentiq ID](https://www.authentiq.com/) or check out the [Authentiq Connect](https://developers.authentiq.com) developer documentation.\n","termsOfService":"https://www.authentiq.com/terms","title":"Authentiq Connect API","version":"1.0","x-apisguru-categories":["security"],"x-logo":{"backgroundColor":"#F26641","url":"https://www.authentiq.com/theme/images/authentiq-logo-a-inverse.svg"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/AuthentiqID/authentiq-docs/master/docs/swagger/provider.yaml","version":"3.0"}],"x-providerName":"authentiq.io"},"externalDocs":{"description":"Authentiq Developer Docs","url":"https://developers.authentiq.com/"},"paths":{"/authorize":{"get":{"description":"Start a session with Authentiq Connect to authenticate a user.\n\n```\nGET https://connect.authentiq.io/authorize?client_id=<your-client-id>&response_type=code+id_token&scope=openid+email&redirect_uri=<your-redirect-uri>&state=0123456789\n```\n\nThis endpoint also supports the POST method.\n","externalDocs":{"description":"OIDC Authorization Endpoint","url":"http://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint"},"operationId":"authorize","parameters":[{"description":"A client ID obtained from the [Dashboard](https://dashboard.authentiq.com/).\n","in":"query","name":"client_id","required":true,"schema":{"type":"string"}},{"description":"The OIDC response type to use for this authentication flow. Valid choices are `code`, `id_token`, `token`, `token id_token`, `code id_token` `code token` and `code token id_token`, but a client can be configured with a more restricted set.\n","in":"query","name":"response_type","required":true,"schema":{"type":"string"}},{"description":"The space-separated identity claims to request from the end-user. Always include `openid` as a scope for compatibility with OIDC.\n","in":"query","name":"scope","required":true,"schema":{"type":"string"}},{"description":"The location to redirect to after (un)successful authentication. See OIDC for the parameters passed in the query string (`response_mode=query`) or as fragments (`response_mode=fragment`). Unless the client is in test-mode this must be one of the registered redirect URLs.\n","in":"query","name":"redirect_uri","required":true,"schema":{"type":"string"}},{"description":"An opaque string that will be passed back to the redirect URL and therefore can be used to communicate client side state and prevent CSRF attacks.\n","in":"query","name":"state","required":true,"schema":{"type":"string"}},{"description":"Whether to append parameters to the redirect URL in the query string (`query`) or as fragments (`fragment`). This option usually has a sensible default for each of the response types.\n","in":"query","name":"response_mode","required":false,"schema":{"type":"string"}},{"description":"An nonce provided by the client (and opaque to Authentiq Connect) that will be included in any ID Token generated for this session. Clients should use the nonce to mitigate replay attacks.\n","in":"query","name":"nonce","required":false,"schema":{"type":"string"}},{"description":"The authentication display mode, which can be one of `page`, `popup` or `modal`. Defaults to `page`.\n","in":"query","name":"display","required":false,"schema":{"default":"page","type":"string"}},{"description":"Space-delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent. The supported values are: `none`, `login`, `consent`. If `consent` the end-user is asked to (re)confirm what claims they share. Use `none` to check for an active session.\n","in":"query","name":"prompt","required":false,"schema":{"default":"login","type":"string"}},{"description":"Specifies the allowable elapsed time in seconds since the last time the end-user was actively authenticated.\n","in":"query","name":"max_age","required":false,"schema":{"default":0,"type":"integer"}},{"description":"Specifies the preferred language to use on the authorization page, as a space-separated list of BCP47 language tags. Ignored at the moment.\n","in":"query","name":"ui_locales","required":false,"schema":{"type":"string"}}],"responses":{"302":{"description":"A successful or erroneous authentication response.\n"},"303":{"description":"*Sign in with Authentiq* page, popup or modal.\n"}},"summary":"Authenticate a user","tags":["Authentication"]}},"/client":{"get":{"description":"Retrieve a list of clients.\n","operationId":"client","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Client"},"type":"array"}}},"description":"A list of Client Objects."},"default":{"$ref":"#/components/responses/OAuth2Error"}},"security":[{"client_registration_token":[]},{"oauth_code":[]},{"oauth_implicit":[]}],"summary":"List clients","tags":["Client Management"]},"post":{"description":"Register a new client with this Authentiq Connect provider.\n\nThis endpoint is compatible with [OIDC's Client Registration](http://openid.net/specs/openid-connect-registration-1_0.html) extension.\n","externalDocs":{"description":"OIDC Client Registration Endpoint","url":"http://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration"},"operationId":"createClient","requestBody":{"$ref":"#/components/requestBodies/Client"},"responses":{"201":{"description":"Client created","headers":{"Location":{"description":"URL of new client resource","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ProblemDetail"}},"security":[{"client_registration_token":[]},{"oauth_code":[]},{"oauth_implicit":[]}],"summary":"Register a client","tags":["Client Management"]}},"/client/{client_id}":{"delete":{"description":"Delete a previously registered client.\n","externalDocs":{"description":"OIDC Client Configuration Endpoint","url":"http://openid.net/specs/openid-connect-registration-1_0.html#ClientConfigurationEndpoint"},"operationId":"clientClient_id","parameters":[{"$ref":"#/components/parameters/client_id"}],"responses":{"204":{"description":"Client deleted"},"default":{"$ref":"#/components/responses/ProblemDetail"}},"security":[{"client_registration_token":[]},{"oauth_code":[]},{"oauth_implicit":[]}],"summary":"Delete a client","tags":["Client Management"]},"get":{"description":"Retrieve the configuration of a previously registered client.\n","externalDocs":{"description":"OIDC Client Configuration Endpoint","url":"http://openid.net/specs/openid-connect-registration-1_0.html#ClientConfigurationEndpoint"},"operationId":"getClient","parameters":[{"$ref":"#/components/parameters/client_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Client found"},"default":{"$ref":"#/components/responses/OAuth2Error"}},"security":[{"client_registration_token":[]},{"oauth_code":[]},{"oauth_implicit":[]}],"summary":"View a client","tags":["Client Management"]},"put":{"description":"Update the configuration of a previously registered client.\n","externalDocs":{"description":"OIDC Client Configuration Endpoint","url":"http://openid.net/specs/openid-connect-registration-1_0.html#ClientConfigurationEndpoint"},"operationId":"updateClient","parameters":[{"$ref":"#/components/parameters/client_id"}],"requestBody":{"$ref":"#/components/requestBodies/Client"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Client updated"},"default":{"$ref":"#/components/responses/ProblemDetail"}},"security":[{"client_registration_token":[]},{"oauth_code":[]},{"oauth_implicit":[]}],"summary":"Update a client","tags":["Client Management"]}},"/token":{"post":{"description":"Exchange en authorization code for an ID Token or Access Token.\n\nThis endpoint supports both `client_secret_basic` (default) and `client_secret_basic` authentication methods, as specified by the client's `token_endpoint_auth_method`.\n","externalDocs":{"description":"OIDC Token Endpoint","url":"http://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint"},"operationId":"token","parameters":[{"description":"HTTP Basic authorization header.\n","in":"header","name":"Authorization","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"client_id":{"description":"The registered client ID.\n","type":"string"},"client_secret":{"description":"The registered client ID secret.\n","format":"password","type":"string"},"code":{"description":"The authorization code previously obtained from the Authentication endpoint.\n","type":"string"},"grant_type":{"description":"The authorization grant type, must be `authorization_code`.\n","type":"string"},"redirect_uri":{"description":"The redirect URL that was used previously with the Authentication endpoint.\n","type":"string"}},"required":["client_id","client_secret","grant_type","code","redirect_uri"],"type":"object"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/Token"},"400":{"$ref":"#/components/responses/OAuth2Error"},"401":{"$ref":"#/components/responses/OAuth2Error"}},"summary":"Obtain an ID Token","tags":["Authentication"]}},"/userinfo":{"get":{"description":"Use this endpoint to retrieve a user's profile in case you are unable to parse an ID Token or you've not already obtained enough details from the ID Token via the Token Endpoint.\n","externalDocs":{"description":"OIDC UserInfo Endpoint","url":"http://openid.net/specs/openid-connect-core-1_0.html#UserInfo"},"operationId":"userInfo","responses":{"200":{"$ref":"#/components/responses/UserInfo"},"401":{"$ref":"#/components/responses/OAuth2Error"},"default":{"$ref":"#/components/responses/OAuth2Error"}},"security":[{"oauth_code":["oidc","email","phone","address","aq:location","aq:name","aq:push"]},{"oauth_implicit":["oidc","email","phone","address","aq:location","aq:name","aq:push"]}],"summary":"Retrieve a user profile","tags":["Authentication"]}},"/{client_id}/iframe":{"get":{"description":"An OpenID Connect Session Management iframe to facilitate e.g. single sign-on or remote logouts.\n\nThe iframe implements the OIDC postMessage-based [change notification protocol](http://openid.net/specs/openid-connect-session-1_0.html#ChangeNotification) via which a client can receive notifications about session state changes.\n","externalDocs":{"description":"OIDC OP Session Management Iframe","url":"http://openid.net/specs/openid-connect-session-1_0.html#OPiframe"},"operationId":"authorizeIframe","parameters":[{"$ref":"#/components/parameters/client_id"}],"responses":{"200":{"description":"OK","headers":{"Cache-Control":{"description":"public, max-age=7200","schema":{"type":"string"}}}}},"summary":"Include a session iframe","tags":["Session Management"]}}},"components":{"parameters":{"client_id":{"description":"Client identifier","in":"path","name":"client_id","required":true,"schema":{"type":"string"}}},"requestBodies":{"Client":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Client Object","required":true}},"responses":{"OAuth2Error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2Error"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/OAuth2Error"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OAuth2Error"}},"text/html":{"schema":{"$ref":"#/components/schemas/OAuth2Error"}}},"description":"OAuth 2.0 error response"},"ProblemDetail":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"text/html":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}},"description":"Problem Detail error response"},"Token":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Token"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Token"}},"text/html":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"Token response"},"UserInfo":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfo"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/UserInfo"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UserInfo"}},"text/html":{"schema":{"$ref":"#/components/schemas/UserInfo"}}},"description":"UserInfo response"}},"schemas":{"Address":{"description":"OIDC Address structure","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postal_code":{"type":"string"},"region":{"type":"string"},"street_address":{"type":"string"}}},"Client":{"description":"Client object","properties":{"application_type":{"type":"string"},"client_id":{"type":"string"},"client_name":{"type":"string"},"client_uri":{"type":"string"},"contacts":{"items":{"type":"string"},"type":"array"},"default_max_age":{"format":"int64","type":"integer"},"default_scopes":{"items":{"type":"string"},"type":"array"},"grant_types":{"items":{"type":"string"},"type":"array"},"logo_uri":{"type":"string"},"policy_uri":{"type":"string"},"redirect_uris":{"items":{"type":"string"},"type":"array"},"response_types":{"items":{"type":"string"},"type":"array"},"tos_uri":{"type":"string"}},"required":["client_name","client_uri"]},"OAuth2Error":{"description":"Error Response defined as in Section 5.2 of OAuth 2.0 [RFC6749].\n","properties":{"error":{"type":"string"},"error_description":{"type":"string"}},"required":["error"]},"ProblemDetail":{"description":"HTTP Problem Detail\n","properties":{"detail":{"description":"Human-readable explanation specific to this occurrence of the problem.\n","type":"string"},"status":{"description":"The HTTP status code for this occurrence of the problem.\n","type":"integer"},"title":{"description":"Human-readable summary of the problem type.\n","type":"string"},"type":{"default":"about:blank","type":"string"}},"required":["type","status"]},"Session":{"description":"Session object","properties":{"authenticated_at":{"format":"date-time","type":"string"},"client_id":{"type":"string"},"client_name":{"type":"string"},"client_uri":{"type":"string"},"concluded_at":{"format":"date-time","type":"string"},"connected_at":{"format":"date-time","type":"string"},"contacts":{"items":{"type":"string"},"type":"array"},"created_at":{"type":"string"},"deleted_at":{"format":"date-time","type":"string"},"logo_uri":{"type":"string"},"nonce":{"type":"string"},"policy_uri":{"type":"string"},"redirect_uri":{"type":"string"},"response_mode":{"type":"string"},"response_type":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"},"scopes_optional":{"items":{"type":"string"},"type":"array"},"scopes_required":{"items":{"type":"string"},"type":"array"},"scopes_seen":{"items":{"type":"string"},"type":"array"},"scopes_signed":{"items":{"type":"string"},"type":"array"},"session_id":{"type":"string"},"session_state":{"type":"string"},"session_uri":{"type":"string"},"sub":{"type":"string"},"tokens_seen":{"items":{"type":"string"},"type":"array"},"tos_uri":{"type":"string"},"version":{"type":"integer"}}},"Token":{"description":"Successful token response\n","properties":{"access_token":{"description":"The access token issued by the authorization server.","type":"string"},"expires_at":{"description":"The time the access token will expire in seconds since epoch.","format":"int64","type":"integer"},"expires_in":{"description":"The lifetime in seconds of the access token.","format":"int32","type":"integer"},"id_token":{"description":"ID Token value associated with the authenticated session.","type":"string"},"refresh_token":{"description":"The refresh token issued to the client, if any.","type":"string"},"scope":{"description":"The scope of the granted tokens.","type":"string"},"token_type":{"type":"string"}},"required":["token_type"]},"UserInfo":{"description":"OIDC UserInfo structure","properties":{"address":{"$ref":"#/components/schemas/Address"},"aq:location":{"description":"Geolocation structure","properties":{"address":{"$ref":"#/components/schemas/Address"},"latitude":{"format":"float","type":"number"},"longitude":{"format":"float","type":"number"}}},"email":{"type":"string"},"email_verified":{"type":"boolean"},"family_name":{"type":"string"},"given_name":{"type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"phone_number_verified":{"type":"boolean"},"sub":{"type":"string"}},"required":["sub"]}},"securitySchemes":{"client_registration_token":{"description":"Client management via registration token.","in":"header","name":"Authorization","type":"apiKey"},"client_secret":{"description":"Session management by confidential clients.","flows":{"password":{"scopes":{"clients":"Enable client management"},"tokenUrl":"https://connect.authentiq.io/token"}},"type":"oauth2"},"oauth_code":{"description":"End-user authentication.","flows":{"authorizationCode":{"authorizationUrl":"https://connect.authentiq.io/authorize","scopes":{"address":"The user's postal address","aq:location":"The user's current location","aq:name":"The user's full name","aq:push":"Enable *One click sign-in*","email":"The user's email address","oidc":"Enable OIDC flow","phone":"The user's phone number"},"tokenUrl":"https://connect.authentiq.io/token"}},"type":"oauth2"},"oauth_implicit":{"description":"End-user authentication.","flows":{"implicit":{"authorizationUrl":"https://connect.authentiq.io/authorize","scopes":{"address":"The user's postal address","aq:location":"The user's current location","aq:name":"The user's full name","aq:push":"Enable *One click sign-in*","email":"The user's email address","oidc":"Enable OIDC flow","phone":"The user's phone number"}}},"type":"oauth2"},"user_jwt":{"description":"Session management by Authentiq ID.","flows":{"clientCredentials":{"scopes":{"session":"Enable session management"},"tokenUrl":"https://connect.authentiq.io/token"}},"type":"oauth2"}}}}