Configure endpoint paths

You can override the default paths for a number of endpoints by adding a serverConfig {paths} structure.

Property Description

Property	Description
authenticate	Override the default path to AM’s `/json/authenticate` endpoint. Default: `json/{realmPath}/authenticate`
authorize	Override the default path to AM’s `/oauth2/authorize` endpoint. Default: `oauth2/{realmPath}/authorize`
accessToken	Override the default path to AM’s `/oauth2/access_token` endpoint. Default: `oauth2/{realmPath}/access_token`
revoke	Override the default path to AM’s `/oauth2/token/revoke` endpoint. Default: `oauth2/{realmPath}/token/revoke`
userInfo	Override the default path to AM’s `/oauth2/userinfo` endpoint. Default: `oauth2/{realmPath}/userinfo`
sessions	Override the default path to AM’s `/json/sessions` endpoint. Default: `json/{realmPath}/sessions`
endSession	Override the default path to AM’s `/oauth2/connect/endSesison` endpoint. Default: `oauth2/{realmPath}/connect/endSession`

authenticate

Override the default path to AM’s /json/authenticate endpoint.
Default: json/{realmPath}/authenticate

authorize

Override the default path to AM’s /oauth2/authorize endpoint.
Default: oauth2/{realmPath}/authorize

accessToken

Override the default path to AM’s /oauth2/access_token endpoint.
Default: oauth2/{realmPath}/access_token

revoke

Override the default path to AM’s /oauth2/token/revoke endpoint.
Default: oauth2/{realmPath}/token/revoke

userInfo

Override the default path to AM’s /oauth2/userinfo endpoint.
Default: oauth2/{realmPath}/userinfo

sessions

Override the default path to AM’s /json/sessions endpoint.
Default: json/{realmPath}/sessions

endSession

Override the default path to AM’s /oauth2/connect/endSesison endpoint.
Default: oauth2/{realmPath}/connect/endSession

Example:

forgerock.Config.set({
    serverConfig: {
        baseUrl: 'https://openam.example.com:8443/openam/',
        paths: {
            authenticate: 'iam/endpoints/authN',
            authorize: 'iam/endpoints/authZ'
        },
        timeout: '30000',
    },
    realmPath: 'root',
    tree: 'sdkAuthenticationTree'
});

Any endpoint paths that you do not override use the pre-configured defaults.

ForgeRock SDKs

Configure endpoint paths