Sign in
developers

Register Site

Registers site at oxd-server

post/register-site

Request body

authorization_redirect_uristring required
op_hoststring

If missing, must be present in defaults

post_logout_redirect_uristring
application_typestring
response_typesstring[]
grant_typesstring[]
scopestring[]
acr_valuesstring[]
client_namestring

oxd will generate its own non-human readable name by default if client_name is not specified

client_jwks_uristring
client_token_endpoint_auth_methodstring
client_request_urisstring[]
client_frontchannel_logout_urisstring[]
client_sector_identifier_uristring
contactsstring[]
redirect_urisstring[]
ui_localesstring[]
claims_localesstring[]
claims_redirect_uristring[]
client_idstring

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_secretstring

client secret of existing client, must be used together with client_id

trusted_clientboolean

specifies whether client is trusted. Default value is false.

access_token_as_jwtboolean

specifies whether access_token should be return as JWT or not. Default value is false.

access_token_signing_algstring

sets signing algorithm used for JWT signing. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512

Example request

{
  "authorization_redirect_uri": "https://client.example.org/cb",
  "op_host": "https://<ophostname>",
  "post_logout_redirect_uri": "https://client.example.org/cb",
  "application_type": "web",
  "response_types": [
    "code"
  ],
  "grant_types": [
    "authorization_code",
    "client_credentials"
  ],
  "scope": [
    "openid"
  ],
  "acr_values": [
    "basic"
  ],
  "contacts": [
    "foo_bar@spam.org"
  ],
  "redirect_uris": [
    "https://client.example.org/cb"
  ]
}

Response

OK

oxd_idstring required
op_hoststring required
client_idstring
client_secretstring
client_registration_access_tokenstring
client_registration_client_uristring
client_id_issued_atinteger
client_secret_expires_atinteger

Example response

{
  "oxd_id": "bcad760f-91ba-46e1-a020-05e4281d91b6",
  "op_host": "https://<op-hostname>",
  "client_id": "@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387",
  "client_secret": "f436b936-03fc-433f-9772-53c2bc9e1c74",
  "client_registration_access_token": "d836df94-44b0-445a-848a-d43189839b17",
  "client_registration_client_uri": "https://<op-hostname>/oxauth/restv1/register?client_id=@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387",
  "client_id_issued_at": 1501854943,
  "client_secret_expires_at": 1501941343
}

Changes