REST APIs

Installation & Running the Project

Make sure you have Docker or a JDK 16 build environment including Gradle installed on your machine

Docker Build

1. Cloning the project

git clone https://github.com/walt-id/waltid-idpkit.git

2. Changing directory

cd waltid-idpkit

3. Building the project

docker build --rm -t waltid/idpkit .

4. Creating an alias (optional)

alias waltid-idpkit="docker run -p 8080:8080 -e WALTID_DATA_ROOT=/data -v $PWD:/data waltid/idpkit"

5. Running the project (with alias)

waltid-idpkit run

6. Running the project (without alias)

docker run -p 8080:8080 -e WALTID_DATA_ROOT

7. Configure the IDP Kit to your needs

IDP Kit configuration and setup

Local Build

1. Cloning the project

git clone https://github.com/walt-id/waltid-idpkit.git

2. Changing directory

cd waltid-idpkit

3. Building the project

./gradlew build install

4. Creating an alias (optional)

alias waltid-idpkit="build/install/waltid-idpkit/bin/waltid-idpkit"

5. Running the project (with alias)

waltid-idpkit run

6. Running the project (without alias)

build/install/waltid-idpkit/bin/waltid-idpkit run

7. Configure the IDP Kit to your needs

IDP Kit configuration and setup

To get info about available options of the run command, use:

waltid-idpkit run --help

For more build options, please refer to the build section

Binding address and port

Refer to IDP Kit setup and configuration, to find out details about binding address and port on which the REST APIs are exposed.

API services

• OIDC API is available under the context path /api/oidc/

• SIOP API is available under the context path /api/siop/

Swagger API documentation

A swagger documentation of all exposed APIs is available under /api/swagger

Publicly deployed API documentation

You can find the publicly deployed API documentations for our stable and rolling deployments:

• Rolling deployment: https://idp.walt-test.cloud/api/swagger
• Stable deployment: https://idp.walt.id/api/swagger