1- aurl
2- ====
1+ # aurl
32
43![ Release] ( https://github.com/classmethod/aurl/workflows/Release/badge.svg )
54[ ![ License] ( https://img.shields.io/github/license/classmethod/aurl.svg )] ( https://github.com/classmethod/aurl/blob/master/LICENSE )
@@ -10,11 +9,11 @@ HTTP CLI client with OAuth 2.0 authentication.
109
1110You know ` curl ` is powerful command line tool and you can make any complex HTTP request to every servers.
1211But the target web server is secured by OAuth 2.0, you must send another HTTP request to the authorization server
13- before making principal request. And more, you should to manage issued access tokens for every resources.
12+ before making principal request. And more, you should to manage issued access tokens for every resources.
1413
1514` aurl ` is a command-line tool that process OAuth 2.0 dance and manage access/refresh tokens automatically.
1615
17- ** Note:** Currently, ` aurl ` is not support OAuth 1.0a. Your pull-request is appreciated.
16+ ** Note:** Currently, ` aurl ` is not support OAuth 1.0a. Your pull-request is appreciated.
1817
1918## Install
2019
@@ -51,21 +50,21 @@ Each section name is used as profile name.
5150
5251###### SYNOPSIS
5352
54- Section name is utilized as profile name. In each section following key settings are available:
55-
56- | key name | description | default value | available values | mandatory |
57- | ----------------------------- | --------------------------------- | :-------------: | :----------------: | :-------------------------------: |
58- | grant \_ type | OAuth2 grant type | authorization_code | authorization_code, password, client_credentials | no |
59- | client \_ id | client id | aurl | (any) | no |
60- | client_secret | client secret | aurl | (any) | no |
61- | auth \_ server \_ auth \_ endpoint | OAuth2 authorization endpoint URI | (none) | (any) | YES (except for password grant) |
62- | auth \_ server \_ token \_ endpoint | OAuth2 token endpoint URI | (none) | (any) | YES |
63- | redirect | redirect URI | (none) | (any) | YES (except for password grant) |
64- | scopes | space separated scope values | read write | (any) | no |
65- | username | username for password grant | (none) | (any) | no (except for password grant) |
66- | password | password for password grant | (none) | (any) | no (except for password grant) |
67- | default \_ content \_ type | default content type header | (none) | (any) | no |
68- | default \_ user \_ agent | default user agent header | aurl x.x.x | (any) | no |
53+ Section name is utilized as profile name. In each section following key settings are available:
54+
55+ | key name | description | default value | available values | mandatory |
56+ | -------------------------- | --------------------------------- | :----------------: | :----------------------------------------------: | :-----------------------------: |
57+ | grant_type | OAuth2 grant type | authorization_code | authorization_code, password, client_credentials | no |
58+ | client_id | client id | aurl | (any) | no |
59+ | client_secret | client secret | aurl | (any) | no |
60+ | auth_server_auth_endpoint | OAuth2 authorization endpoint URI | (none) | (any) | YES (except for password grant) |
61+ | auth_server_token_endpoint | OAuth2 token endpoint URI | (none) | (any) | YES |
62+ | redirect | redirect URI | (none) | (any) | YES (except for password grant) |
63+ | scopes | space separated scope values | read write | (any) | no |
64+ | username | username for password grant | (none) | (any) | no (except for password grant) |
65+ | password | password for password grant | (none) | (any) | no (except for password grant) |
66+ | default_content_type | default content type header | (none) | (any) | no |
67+ | default_user_agent | default user agent header | aurl x.x.x | (any) | no |
6968
7069Implicit flow is not supported currently.
7170
@@ -107,7 +106,7 @@ scopes = https://www.googleapis.com/auth/plus.login https://www.googleapis.com/a
107106
108107### Token store file
109108
110- Token store file ` ~/.aurl/token/*.json ` is used by aurl internally. Retrieved token response body is stored in this file.
109+ Token store file ` ~/.aurl/token/*.json ` is used by aurl internally. Retrieved token response body is stored in this file.
111110You SHOULD NOT edit this file manually because this file is overwritten at any time curl is executed.
112111You may lose comment and another extra data.
113112
@@ -158,7 +157,7 @@ $ aurl --profile google https://www.googleapis.com/plus/v1/people/me
158157}
159158```
160159
161- By default aurl prints response body in stdout. When an error occured the detail is printed in stderr.
160+ By default aurl prints response body in stdout. When an error occured the detail is printed in stderr.
162161You may want not response body but response header, then you can use ` --no-print-body ` and ` --print-headers ` option.
163162
164163``` bash
0 commit comments