Skip to content

Commit

Permalink
docs: document authorization endpoint (#3455)
Browse files Browse the repository at this point in the history
* docs: add overview

* docs: add overview and outline
  • Loading branch information
ossdhaval authored Dec 29, 2022
1 parent 0417c2a commit 5f7b58e
Showing 1 changed file with 48 additions and 4 deletions.
52 changes: 48 additions & 4 deletions docs/admin/auth-server/endpoints/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,60 @@
tags:
- administration
- auth-server
- authorization
- 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.
Janssen Server exposes authorization endpoint compliant with [OAuth2 framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.1).
A client uses authorization endpoint to obtain an authorization grant. Based on response type requested by the client,
the authorization endpoint issues an authorization code or an access token. Authorization endpoint is a protected endpoint
which will require end-user authentication before issuing authorization code or access token.

## Have questions in the meantime?
URL to access authorization 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://<jans-server-host>/jans-auth/.well-known/openid-configuration
```

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

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

More information about request and response of the authorization 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#/Authorization).

## Disabling The Endpoint Using Feature Flag

TODO: It seems this endpoint can't be disabled using featureflags. Confirm this.


## Configuration Properties

TODO: Find properties relevant to this endpoint

## Required Client Configuration

TODO: elaborate on client must be registered with appropriate grant type (code and implicit)

## Configuring Authentication Methods

TODO: Elaborate on interception scripts

## Using PKCE

## Using PAR

## Using JARM

## Authorization Flows

TODO: Flows should be elaborated in separate documents if needed. Just add link here.

## Want to contribute?

Expand Down

0 comments on commit 5f7b58e

Please sign in to comment.