Skip to content

Commit

Permalink
docs(config-api): updated config-api overview and configuration docs (#…
Browse files Browse the repository at this point in the history
…3129)

* docs(config-api): docs for app config, plugin, attribute and client

* docs(config-api): updated config-api overview and configuration docs
  • Loading branch information
pujavs authored Nov 30, 2022
1 parent 597f367 commit 067405a
Show file tree
Hide file tree
Showing 3 changed files with 201 additions and 213 deletions.
34 changes: 30 additions & 4 deletions docs/admin/config-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,35 @@ tags:
- config-api
---

# Overview
# config-api

Please use the left navigation menu to browse the content of this section while we are still working on developing content for `Overview` page.
## Overview
[Jans Config Api](https://github.com/JanssenProject/jans/tree/main/jans-config-api) provides a central place to manage and configure jans modules.
It helps in configuring auth-server, users, fido2 and scim modules.
Config API is a REST application that is developed using Weld 4.x (JSR-365) and JAX-RS. Its endpoints can be used to manage configuration and other properties of [Jans Auth Server] (https://github.com/JanssenProject/jans/tree/main/jans-auth-server), which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS)
![Config-API-Architecture](../../../assets/config-api-architecture.png)
If you want to learn more about Weld, please visit its website: https://weld.cdi-spec.org/

!!! Contribute
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation)
## Packaging and running the application
The application can be packaged using `./mvnw package`.
It produces the `jans-config-api.war` file in the `server/target` directory.
Be aware that all the dependencies are copied into the `server/target/jans-config-api/WEB-INF/lib` directory.

## Plugins
Jans Config API follow a flexible plugin architecture in which the new features can be added using extensions called plugins without altering the application itself. In this section, we will discuss the steps to develop and add plugins in Jans Config API.
![Refer] (/plugins.md) for more details.

## Endpoints protection
Config API endpoints are OAuth 2.0 protected. It supports simple bearer and JWT token.

## Documentation
Learn more in the [jans-config-api documentation](https://gluu.org/swagger-ui/?url=https://raw.githubusercontent.com/JanssenProject/jans/main/jans-config-api/docs/jans-config-api-swagger.yaml).

### Endpoints
#### Attribute
Attributes are individual pieces of user data, like uid or email, that are required by applications in order to identify a user and grant access to protected resources.
![Refer] (./attribute.md) for more details.

#### Default Authentication Method
Attributes are individual pieces of user data, like uid or email, that are required by applications in order to identify a user and grant access to protected resources.
![Refer] (/default-authentication-method.md) for more details.
179 changes: 0 additions & 179 deletions docs/admin/config-api/config-api-configuration.md

This file was deleted.

Loading

0 comments on commit 067405a

Please sign in to comment.