Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for clientinfo endpoint #3519

Merged
merged 1 commit into from
Jan 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 41 additions & 7 deletions docs/admin/auth-server/endpoints/clientinfo.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,51 @@
---
tags:
- administration
- auth-server
- endpoint
- administration
- auth-server
- clientinfo
- endpoint
---

## This content is in progress
# Overview

The Janssen Project documentation is currently in development. Topic pages are being created in order of broadest relevance, and this page is coming in the near future.
`/clientinfo` endpoint is an OAuth2 protected endpoint that is used to retrieve claims about registered client.

## Have questions in the meantime?
URL to access clientinfo endpoint on Janssen Server is listed in the response of Janssen Server's well-known
[configuration endpoint](./configuration.md) given below.

While this documentation is in progress, you can ask questions through [GitHub Discussions](https://github.com/JanssenProject/jans/discussion) or the [community chat on Gitter](https://gitter.im/JanssenProject/Lobby). Any questions you have will help determine what information our documentation should cover.
```text
https://janssen.server.host/jans-auth/.well-known/openid-configuration
```

`clientinfo_endpoint` claim in the response specifies the URL for clientinfo endpoint. By default, clientinfo endpoint looks
like below:

```
https://janssen.server.host/jans-auth/restv1/clientinfo
```

Since clientinfo endpoint is an OAuth2 protected resource, a valid access token with appropriate scope is required to
access the endpoint. More information about request and response of the clientinfo endpoint can be found in
the OpenAPI specification of [jans-auth-server module](https://gluu.org/swagger-ui/?url=https://raw.githubusercontent.com/JanssenProject/jans/replace-janssen-version/jans-auth-server/docs/swagger.yaml#/Client_Info).

## Disabling The Endpoint Using Feature Flag

`/clientinfo` endpoint can be enabled or disable using [clientinfo feature flag](../../reference/json/feature-flags/janssenauthserver-feature-flags.md#clientinfo).
Use [Janssen Text-based UI(TUI)](../../config-guide/tui.md) or [Janssen command-line interface](../../config-guide/jans-cli/README.md) to perform this task.

When using TUI, navigate via `Auth Server`->`Properties`->`enabledFeatureFlags` to screen below. From here, enable or
disable `clientinfo` flag as required.

![](../../../assets/image-tui-enable-components.png)

## Configuration Properties

Clientinfo endpoint can be further configured using Janssen Server configuration properties listed below. When using
[Janssen Text-based UI(TUI)](../../config-guide/tui.md) to configure the properties,
navigate via `Auth Server`->`Properties`.

- [clientInfoEndpoint](../../reference/json/properties/janssenauthserver-properties.md#clientinfoendpoint)
- [mtlsClientInfoEndpoint](../../reference/json/properties/janssenauthserver-properties.md#mtlsclientinfoendpoint)

## Want to contribute?

Expand Down