Skip to content

Commit 23f0148

Browse files
committed
docs: document service_config
1 parent ebfba11 commit 23f0148

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/oauth.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ These are all the possible fields of a *settings.yaml* file:
7171
redirect_uri: {{str}}
7272
revoke_uri: {{str}}
7373
74+
service_config:
75+
client_json_file_path: {{str}}
76+
client_json_dict: {{dict}}
77+
client_json: {{str}}
78+
7479
save_credentials: {{bool}}
7580
save_credentials_backend: {{str}}
7681
save_credentials_file: {{str}}
@@ -83,15 +88,19 @@ These are all the possible fields of a *settings.yaml* file:
8388
8489
Fields explained:
8590

86-
:client_config_backend (str): From where to read client configuration(API application settings such as client_id and client_secrets) from. Valid values are 'file' and 'settings'. **Default**: 'file'. **Required**: No.
91+
:client_config_backend (str): From where to read client configuration(API application settings such as client_id and client_secrets) from. Valid values are 'file', 'settings' and 'service'. **Default**: 'file'. **Required**: No.
8792
:client_config_file (str): When *client_config_backend* is 'file', path to the file containing client configuration. **Default**: 'client_secrets.json'. **Required**: No.
88-
:client_config (dict): Place holding dictionary for client configuration when *client_config_backend* is 'settings'. **Required**: Yes, only if *client_config_backend* is 'settings'
93+
:client_config (dict): Place holding dictionary for client configuration when *client_config_backend* is 'settings'. **Required**: Yes, only if *client_config_backend* is 'settings' and not using *service_config*
8994
:client_config['client_id'] (str): Client ID of the application. **Required**: Yes, only if *client_config_backend* is 'settings'
9095
:client_config['client_secret'] (str): Client secret of the application. **Required**: Yes, only if *client_config_backend* is 'settings'
9196
:client_config['auth_uri'] (str): The authorization server endpoint URI. **Default**: 'https://accounts.google.com/o/oauth2/auth'. **Required**: No.
9297
:client_config['token_uri'] (str): The token server endpoint URI. **Default**: 'https://accounts.google.com/o/oauth2/token'. **Required**: No.
9398
:client_config['redirect_uri'] (str): Redirection endpoint URI. **Default**: 'urn:ietf:wg:oauth:2.0:oob'. **Required**: No.
9499
:client_config['revoke_uri'] (str): Revoke endpoint URI. **Default**: None. **Required**: No.
100+
:service_config (dict): Place holding dictionary for client configuration when *client_config_backend* is 'service' or 'settings' and using service account. **Required**: Yes, only if *client_config_backend* is 'service' or 'settings' and not using *client_config*
101+
:service_config['client_json_file_path'] (str): Path to service account `.json` key file. **Required**: No.
102+
:service_config['client_json_dict'] (dict): Service account `.json` key file loaded into a dictionary. **Required**: No.
103+
:service_config['client_json'] (str): Service account `.json` key file loaded into a string. **Required**: No.
95104
:save_credentials (bool): True if you want to save credentials. **Default**: False. **Required**: No.
96105
:save_credentials_backend (str): Backend to save credentials to. 'file' and 'dictionary' are the only valid values for now. **Default**: 'file'. **Required**: No.
97106
:save_credentials_file (str): Destination of credentials file. **Required**: Yes, only if *save_credentials_backend* is 'file'.

0 commit comments

Comments
 (0)