---
title: "Register Site"
method: POST
path: "/register-site"
tags: ["developers"]
---

# Register Site

`POST /register-site`

Registers site at oxd-server

## Request body

- object
  - `authorization_redirect_uri` string, required
  - `op_host` string — If missing, must be present in defaults
  - `post_logout_redirect_uri` string
  - `application_type` string
  - `response_types` string[]
  - `grant_types` string[]
  - `scope` string[]
  - `acr_values` string[]
  - `client_name` string — oxd will generate its own non-human readable name by default if client_name is not specified
  - `client_jwks_uri` string
  - `client_token_endpoint_auth_method` string
  - `client_request_uris` string[]
  - `client_frontchannel_logout_uris` string[]
  - `client_sector_identifier_uri` string
  - `contacts` string[]
  - `redirect_uris` string[]
  - `ui_locales` string[]
  - `claims_locales` string[]
  - `claims_redirect_uri` string[]
  - `client_id` string — client id of existing client, ignores all other parameters and skips new client registration forcing to use existing client (client_secret is required if this parameter is set)
  - `client_secret` string — client secret of existing client, must be used together with client_id
  - `trusted_client` boolean — specifies whether client is trusted. Default value is false.
  - `access_token_as_jwt` boolean — specifies whether access_token should be return as JWT or not. Default value is false.
  - `access_token_signing_alg` string — sets signing algorithm used for JWT signing. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512
  - `rpt_as_jwt` boolean — specifies whether RPT should be return as JWT or not. Default value is false.

## Response `200`

OK

- object
  - `oxd_id` string, required
  - `op_host` string, required
  - `client_id` string
  - `client_secret` string
  - `client_registration_access_token` string
  - `client_registration_client_uri` string
  - `client_id_issued_at` integer
  - `client_secret_expires_at` integer

## Other responses

- `400` — Invalid parameters are provided to endpoint.
- `403` — Forbidden. Invalid access token provided in Authorization header.
- `500` — Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log).

## Changes

- **2018-11-30** `c28eaefdb285` — 5 breaking
  - removed the request body
  - removed the media type `application/json` for the response with the status `200`
  - removed the media type `application/json` for the response with the status `400`
  - removed the media type `application/json` for the response with the status `403`
  - …1 more

[Change history](https://skmtc.dev/gluufederation/apis/oxd-server/changes/register-site/post.md)

---

[API](https://skmtc.dev/gluufederation/apis/oxd-server.md) · [All operations](https://skmtc.dev/gluufederation/apis/oxd-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gluufederation/oxd-server/revisions/8fc17f52c8a2/schema)