]> BookStack Code Mirror - bookstack/blob - app/Config/openid.php
Generalize refresh failure handling
[bookstack] / app / Config / openid.php
1 <?php
2
3 return [
4
5     // Display name, shown to users, for OpenId option
6     'name' => env('OPENID_NAME', 'SSO'),
7
8     // Dump user details after a login request for debugging purposes
9     'dump_user_details' => env('OPENID_DUMP_USER_DETAILS', false),
10
11     // Attribute, within a OpenId token, to find the user's email address
12     'email_attribute' => env('OPENID_EMAIL_ATTRIBUTE', 'email'),
13     // Attribute, within a OpenId token, to find the user's display name
14     'display_name_attributes' => explode('|', env('OPENID_DISPLAY_NAME_ATTRIBUTES', 'username')),
15     // Attribute, within a OpenId token, to use to connect a BookStack user to the OpenId user.
16     'external_id_attribute' => env('OPENID_EXTERNAL_ID_ATTRIBUTE', null),
17
18     // Overrides, in JSON format, to the configuration passed to underlying OpenIDConnectProvider library.
19     'openid_overrides' => env('OPENID_OVERRIDES', null),
20
21     'openid' => [
22         // OAuth2/OpenId client id, as configured in your Authorization server.
23         'clientId'                => env('OPENID_CLIENT_ID', ''),
24
25         // OAuth2/OpenId client secret, as configured in your Authorization server.
26         'clientSecret'            => env('OPENID_CLIENT_SECRET', ''),
27
28         // OAuth2 scopes that are request, by default the OpenId-native profile and email scopes.
29         'scopes'                  => 'profile email',
30
31         // The issuer of the identity token (id_token) this will be compared with what is returned in the token.
32         'idTokenIssuer'           => env('OPENID_ISSUER', ''),
33
34         // Public key that's used to verify the JWT token with.
35         'publicKey'               => env('OPENID_PUBLIC_KEY', ''),
36
37         // OAuth2 endpoints.
38         'urlAuthorize'            => env('OPENID_URL_AUTHORIZE', ''),
39         'urlAccessToken'          => env('OPENID_URL_TOKEN', ''),
40         'urlResourceOwnerDetails' => env('OPENID_URL_RESOURCE', ''),
41     ],
42
43 ];