OryHydra.API.Oidc

Operations

Oidc

createOidcDynamicClient

createOidcDynamicClient

Arguments

:: (Consumes CreateOidcDynamicClient MimeJSON, MimeRender MimeJSON OAuth2Client)

=> OAuth2Client

"oAuth2Client" - Dynamic Client Registration Request Body

-> OryHydraRequest CreateOidcDynamicClient MimeJSON OAuth2Client MimeJSON

POST /oauth2/register

Register OAuth2 Client using OpenID Dynamic Client Registration

This endpoint behaves like the administrative counterpart (createOAuth2Client) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. Please note that using this endpoint you are not able to choose the client_secret nor the client_id as those values will be server generated when specifying token_endpoint_auth_method as client_secret_basic or client_secret_post. The client_secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somewhere safe.

data CreateOidcDynamicClient

Instances

HasBodyParam CreateOidcDynamicClient OAuth2Client

Body Param OAuth2Client - Dynamic Client Registration Request Body

Defined in OryHydra.API.Oidc

Methods

setBodyParam :: (Consumes CreateOidcDynamicClient contentType, MimeRender contentType OAuth2Client) => OryHydraRequest CreateOidcDynamicClient contentType res accept -> OAuth2Client -> OryHydraRequest CreateOidcDynamicClient contentType res accept

Consumes CreateOidcDynamicClient MimeJSON

application/json

Defined in OryHydra.API.Oidc

Produces CreateOidcDynamicClient MimeJSON

application/json

Defined in OryHydra.API.Oidc

deleteOidcDynamicClient

deleteOidcDynamicClient

Arguments

:: Id

"id" - The id of the OAuth 2.0 Client.

-> OryHydraRequest DeleteOidcDynamicClient MimeNoContent NoContent MimeNoContent

DELETE /oauth2/register/{id}

Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol

This endpoint behaves like the administrative counterpart (deleteOAuth2Client) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method client_secret_post, you need to present the client secret in the URL query. If it uses client_secret_basic, present the Client ID and the Client Secret in the Authorization header. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

AuthMethod: AuthBasicBearer

data DeleteOidcDynamicClient

Instances

Produces DeleteOidcDynamicClient MimeNoContent

Defined in OryHydra.API.Oidc

discoverOidcConfiguration

discoverOidcConfiguration :: OryHydraRequest DiscoverOidcConfiguration MimeNoContent OidcConfiguration MimeJSON

GET /.well-known/openid-configuration

OpenID Connect Discovery

A mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations. Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/

data DiscoverOidcConfiguration

Instances

Produces DiscoverOidcConfiguration MimeJSON

application/json

Defined in OryHydra.API.Oidc

getOidcDynamicClient

getOidcDynamicClient

Arguments

:: Id

"id" - The id of the OAuth 2.0 Client.

-> OryHydraRequest GetOidcDynamicClient MimeNoContent OAuth2Client MimeJSON

GET /oauth2/register/{id}

Get OAuth2 Client using OpenID Dynamic Client Registration

This endpoint behaves like the administrative counterpart (getOAuth2Client) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method client_secret_post, you need to present the client secret in the URL query. If it uses client_secret_basic, present the Client ID and the Client Secret in the Authorization header.

AuthMethod: AuthBasicBearer

data GetOidcDynamicClient

Instances

Produces GetOidcDynamicClient MimeJSON

application/json

Defined in OryHydra.API.Oidc

getOidcUserInfo

getOidcUserInfo :: OryHydraRequest GetOidcUserInfo MimeNoContent OidcUserInfo MimeJSON

GET /userinfo

OpenID Connect Userinfo

This endpoint returns the payload of the ID Token, including `session.id_token` values, of the provided OAuth 2.0 Access Token's consent request. In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. See the spec for more details about header format.

AuthMethod: AuthOAuthOauth2

data GetOidcUserInfo

Instances

Produces GetOidcUserInfo MimeJSON

application/json

Defined in OryHydra.API.Oidc

revokeOidcSession

revokeOidcSession :: OryHydraRequest RevokeOidcSession MimeNoContent NoContent MimeNoContent

GET /oauth2/sessions/logout

OpenID Connect Front- and Back-channel Enabled Logout

This endpoint initiates and completes user logout at the Ory OAuth2 & OpenID provider and initiates OpenID Connect Front- Back-channel logout: https:openid.netspecsopenid-connect-frontchannel-1_0.html https:openid.netspecs/openid-connect-backchannel-1_0.html Back-channel logout is performed asynchronously and does not affect logout flow.

data RevokeOidcSession

Instances

Produces RevokeOidcSession MimeNoContent

Defined in OryHydra.API.Oidc

setOidcDynamicClient

setOidcDynamicClient

Arguments

:: (Consumes SetOidcDynamicClient MimeJSON, MimeRender MimeJSON OAuth2Client)

=> OAuth2Client

"oAuth2Client" - OAuth 2.0 Client Request Body

-> Id

"id" - OAuth 2.0 Client ID

-> OryHydraRequest SetOidcDynamicClient MimeJSON OAuth2Client MimeJSON

PUT /oauth2/register/{id}

Set OAuth2 Client using OpenID Dynamic Client Registration

This endpoint behaves like the administrative counterpart (setOAuth2Client) but is capable of facing the public internet directly to be used by third parties. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature is disabled per default. It can be enabled by a system administrator. If you pass client_secret the secret is used, otherwise the existing secret is used. If set, the secret is echoed in the response. It is not possible to retrieve it later on. To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method client_secret_post, you need to present the client secret in the URL query. If it uses client_secret_basic, present the Client ID and the Client Secret in the Authorization header. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

AuthMethod: AuthBasicBearer

data SetOidcDynamicClient

Instances

HasBodyParam SetOidcDynamicClient OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.Oidc

Methods

setBodyParam :: (Consumes SetOidcDynamicClient contentType, MimeRender contentType OAuth2Client) => OryHydraRequest SetOidcDynamicClient contentType res accept -> OAuth2Client -> OryHydraRequest SetOidcDynamicClient contentType res accept

Consumes SetOidcDynamicClient MimeJSON

application/json

Defined in OryHydra.API.Oidc

Produces SetOidcDynamicClient MimeJSON

application/json

Defined in OryHydra.API.Oidc