Relying Party

Relying party Configuration

Properties

Name	Description	Default value	Mandatory
client_id	Used for identifying and authenticating the client.	N/A
client_secret	Used for identifying and authenticating the client.	N/A
redirect_uri	Redirect location where the authorization code or JWT should be sent.	N/A
post_logout_redirect_uris	Redirect location after logout.	N/A
pipe_id	Pipe reference. Pipe is run directly after user authentication. Used for collecting data for id_token-and access_token claims.	N/A
id_token_headers	ID token headers configured per RP.	N/A
id_token_claims	ID token claims configured per RP.	N/A
access_token_headers	Access Token headers configured per RP. ONLY used when sending access tokens as JWTs.	N/A
access_token_claims	Access Token claims configured per RP. Also used for userinfo data when calling the userinfo endpoint.	N/A
refresh_token_persist_pipe_id	Optional pipe to send the refresh token to. It is up to the administrator to decide what the pipe will do.	N/A
refresh_token_resolve_pipe_id	Optional pipe to load/resolve a refresh token. The pipe should also create and persist a new refresh token.	N/A
userinfo_pipe_id	Used to generate userinfo data (always plain JSON) when incoming access tokens is of JWT type.	N/A
client_credentials_pipe_id	Pipe to issue an access token when using the client_credentials grant. The client_credentials grant lets a client authenticate itself and obtain an access token to call APIs on its own behalf, without any end-user involved. Machine to machine.	N/A

Example

"rps" : [{
    "client_id" : "provided",
    "client_secret" : "provided",
    "redirect_uri" : ["https://auth.organisation.com/authenticate/oidcrp"],
    "post_logout_redirect_uris" : ["https://auth.organisation.com/authenticate/oidcrp/loggedout"],
    "pipe_id" : "optional_pipe_id",
    "id_token_headers" : 
    },
    "id_token_claims" : {
        "email": "${item.mail}",
        "nonce": "${request.nonce}"
    },
    "access_token_headers" : {
        "typ" : "at+jwt"
    },
    "access_token_claims" : {
        "custom_claim": "static_claim",
        "email": "${item.mail}",
        "email_verified": true,
        "address": {
            "street_address": "my address", 
            "postal_code": "my postal code"
        },
        "given_name": "${item.givenName}",
        "subject": "${item.subject}"
    }
}]