You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/oauth.rst
+15-2
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,12 @@ These are all the possible fields of a *settings.yaml* file:
71
71
redirect_uri: {{str}}
72
72
revoke_uri: {{str}}
73
73
74
+
service_config:
75
+
client_user_email: {{str}}
76
+
client_json_file_path: {{str}}
77
+
client_json_dict: {{dict}}
78
+
client_json: {{str}}
79
+
74
80
save_credentials: {{bool}}
75
81
save_credentials_backend: {{str}}
76
82
save_credentials_file: {{str}}
@@ -83,15 +89,20 @@ These are all the possible fields of a *settings.yaml* file:
83
89
84
90
Fields explained:
85
91
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.
92
+
: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.
87
93
: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'
94
+
: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*
89
95
:client_config['client_id'] (str): Client ID of the application. **Required**: Yes, only if *client_config_backend* is 'settings'
90
96
:client_config['client_secret'] (str): Client secret of the application. **Required**: Yes, only if *client_config_backend* is 'settings'
91
97
:client_config['auth_uri'] (str): The authorization server endpoint URI. **Default**: 'https://accounts.google.com/o/oauth2/auth'. **Required**: No.
92
98
:client_config['token_uri'] (str): The token server endpoint URI. **Default**: 'https://accounts.google.com/o/oauth2/token'. **Required**: No.
: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*
102
+
:service_config['client_user_email'] (str): User email that authority was delegated_ to. **Required**: No.
103
+
:service_config['client_json_file_path'] (str): Path to service account `.json` key file. **Required**: No.
104
+
:service_config['client_json_dict'] (dict): Service account `.json` key file loaded into a dictionary. **Required**: No.
105
+
:service_config['client_json'] (str): Service account `.json` key file loaded into a string. **Required**: No.
95
106
:save_credentials (bool): True if you want to save credentials. **Default**: False. **Required**: No.
96
107
:save_credentials_backend (str): Backend to save credentials to. 'file' and 'dictionary' are the only valid values for now. **Default**: 'file'. **Required**: No.
97
108
:save_credentials_file (str): Destination of credentials file. **Required**: Yes, only if *save_credentials_backend* is 'file'.
@@ -100,6 +111,8 @@ Fields explained:
100
111
:get_refresh_token (bool): True if you want to retrieve refresh token along with access token. **Default**: False. **Required**: No.
101
112
:oauth_scope (list of str): OAuth scope to authenticate. **Default**: ['https://www.googleapis.com/auth/drive']. **Required**: No.
0 commit comments