Commit 1d6b449
Changed files (6)
doc/_includes/oauth-tokens-client-credentials.html
@@ -0,0 +1,61 @@
+
+#### POST http://localhost:5000/oauth/tokens
+
+Example curl request:
+
+```bash
+$ curl http://localhost:5000/oauth/tokens \
+ -X POST \
+ -d '{"grant_type":"client_credentials"}' \
+ -H "Accept: application/json" \
+ -H "Content-Type: application/json" \
+ -H "User-Agent: net/hippie 0.1.9" \
+ -H "Authorization: Basic OGVkMzljOTYtNzk0MS00YWQyLWI0MzUtNDdlNTYwNGU5YWMxOllBZXlGVzZESEN1OFlRU2hjS0Z3V1gzcQ==" \
+ -H "Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
+```
+Request Headers:
+
+```text
+Accept: application/json
+Content-Type: application/json
+User-Agent: net/hippie 0.1.9
+Authorization: Basic OGVkMzljOTYtNzk0MS00YWQyLWI0MzUtNDdlNTYwNGU5YWMxOllBZXlGVzZESEN1OFlRU2hjS0Z3V1gzcQ==
+Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+```
+
+
+Request Body:
+```json
+{
+ "grant_type": "client_credentials"
+}
+```
+
+Response Headers:
+
+```text
+X-Frame-Options: SAMEORIGIN
+X-Xss-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Permitted-Cross-Domain-Policies: none
+Referrer-Policy: strict-origin-when-cross-origin
+Cache-Control: private, no-store
+Pragma: no-cache
+Content-Type: application/json; charset=utf-8
+Etag: W/"741de2d275c50f8edb7b319c01c600dc"
+X-Request-Id: 411d96b6-5388-4743-bb9f-eb009c8818c7
+Transfer-Encoding: chunked
+```
+
+
+Response Body:
+```json
+{
+ "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ5MjIsImlhdCI6MTU0MDc2MTMyMiwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjIsImF1ZCI6IjhlZDM5Yzk2LTc5NDEtNGFkMi1iNDM1LTQ3ZTU2MDRlOWFjMSIsImp0aSI6ImVmMjExMmZhLTgxNzctNDZlMi05ZDhkLWRhMGY5YmIzYzBhNCIsInN1YiI6IjhlZDM5Yzk2LTc5NDEtNGFkMi1iNDM1LTQ3ZTU2MDRlOWFjMSIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.KeNZMVSr0iIJLBzwf1Q653UJTSO9RuvZ8RutZVtZPqEgt9N3MZJzFleHc88FblN1Wv7sIfTtaCInc666tRivNa2bBaS4W7y-3L4pVFmsvFczeARYOhWdRMHCGk9BvQwFjfpKLjGmu17GascqSEGAnCRPbhUbHmhBoqsCbW-iQ1A5MOusDmXSQ53GNx1gamdQkcDrVJZveFXQpW5FQcEkpFgzMxTzgUmxQNowNbNWauRfQRkROZKkabuME8sQrBGFZ0bl7rVS_MyV1Ptmdg_FhpQ7ctWTLhm0WC6ZDNB1pidrXsePjxj8ZFzP5uniu47qg5_3Mbju-NGakwTphvaldA",
+ "token_type": "Bearer",
+ "expires_in": 3600
+}
+```
+
+
doc/_includes/oauth-tokens-password.html
@@ -6,11 +6,11 @@ Example curl request:
```bash
$ curl http://localhost:5000/oauth/tokens \
-X POST \
- -d '{"grant_type":"password","username":"allen@volkmanweissnat.info","password":"s1b5RDJmQY8G"}' \
+ -d '{"grant_type":"password","username":"sheila_torphy@bechtelar.co.uk","password":"OxlUzuoUOrgV5v"}' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "User-Agent: net/hippie 0.1.9" \
- -H "Authorization: Basic YjhkOTgzNTMtMGVjMC00ZTlhLTg0MDItNWE2OWUxZjY5NzZkOkJYd0RybjlWcWFRamRHSjM1OGhuUFNSSg==" \
+ -H "Authorization: Basic MzYzZTczNTUtOTM2NC00Yzg0LTgwMWYtMDU5YjFmZjIwM2I4OnZnY0NyaFJ2bW40WTNUYWVUeWQ1bWlWUQ==" \
-H "Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
```
Request Headers:
@@ -19,7 +19,7 @@ Request Headers:
Accept: application/json
Content-Type: application/json
User-Agent: net/hippie 0.1.9
-Authorization: Basic YjhkOTgzNTMtMGVjMC00ZTlhLTg0MDItNWE2OWUxZjY5NzZkOkJYd0RybjlWcWFRamRHSjM1OGhuUFNSSg==
+Authorization: Basic MzYzZTczNTUtOTM2NC00Yzg0LTgwMWYtMDU5YjFmZjIwM2I4OnZnY0NyaFJ2bW40WTNUYWVUeWQ1bWlWUQ==
Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
```
@@ -28,8 +28,8 @@ Request Body:
```json
{
"grant_type": "password",
- "username": "allen@volkmanweissnat.info",
- "password": "s1b5RDJmQY8G"
+ "username": "sheila_torphy@bechtelar.co.uk",
+ "password": "OxlUzuoUOrgV5v"
}
```
@@ -45,8 +45,8 @@ Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: private, no-store
Pragma: no-cache
Content-Type: application/json; charset=utf-8
-Etag: W/"b22c1725b3a24d9a88d0d82adb5ccead"
-X-Request-Id: 5200b121-3660-429b-be52-a2e9b732b2f4
+Etag: W/"2d39b47999b54df9600f05e81426bcf7"
+X-Request-Id: da983f60-ab3c-4d88-823b-cf692e974d3f
Transfer-Encoding: chunked
```
@@ -54,10 +54,10 @@ Transfer-Encoding: chunked
Response Body:
```json
{
- "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ3MzEsImlhdCI6MTU0MDc2MTEzMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjExMzEsImF1ZCI6ImI4ZDk4MzUzLTBlYzAtNGU5YS04NDAyLTVhNjllMWY2OTc2ZCIsImp0aSI6IjRjYjc0ZjI4LTEwYmEtNDEwYi04NGU5LTg4Mzc2MzQ3NWZjMSIsInN1YiI6IjNiOTRlZGIwLTJlYWItNDAyYi1hZTg2LThmMjVlMmQzMjQ0OSIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.PVN9lWyxjibLlQqGQIS-7RIb64YbUanm-kI8GFibEgw4WmrOGNcuk5Te-w6ISNt0RlluIC1lgOOdBBr6vRVZZoUC8T72l26QzbEHjKANq_2aZffyojiGSoiU9KCXHFjTX4RQCFV40vxje8olCs5x3CpkBszfH24eAhFgvSp8IcDg62fwV98gCWb3fAK3evRmN5A5N66zxpLuESuVX8rG0WjCowdEuhC9f3jxLyKpBX2keFpO5Fq2Ina8HlkQhi4UchMwm2eKtEV63T8UVFojDlsDc-J7KNc5yVRR2XeYmaoDrEJ4oPf5OshbOS58yJ6XpENM4onfRW5O2Nof31SU1w",
+ "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ5MjIsImlhdCI6MTU0MDc2MTMyMiwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjIsImF1ZCI6IjM2M2U3MzU1LTkzNjQtNGM4NC04MDFmLTA1OWIxZmYyMDNiOCIsImp0aSI6ImI0NDQ1M2UwLTNlM2YtNGU0OS05ZDc2LTNjOWE1MTMzNWNlNyIsInN1YiI6ImVkZTJjMzZlLTcwM2QtNDJkMC04MGIzLTNlYzk0ZmMzZDBiMCIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.qqJIgRYh73b0jhLZFEwD-jKfQ5EogHeS6w9g-MYgCbw_l4FeK_fK279hycXzkqU5vu4273I9SFXfz_ftpRiL4xXmlxDusZ6lo_ukYJv_8Uj_nY-tz3fvDvs4uLIAnaSr4GVSX7VjgQMuLJoLplEH-iDPi-VE8HH3KtAhWHF1ddWoLfJbYbmg_-lu-9CmDp-BqD9veDELzpq5OC-D38YHXY7C7xjW3wry8CV37potqkog0xowrFkaqNc9UPZfsJCg_V9GoXN3l59QHv1qgoWItin6TkyhGAc8MgIXTiJeMrMm19YYhNFlUuy67vV5yEOXOzLD6y5-LvcdoR6SOnFkvg",
"token_type": "Bearer",
"expires_in": 3600,
- "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA4NDc1MzEsImlhdCI6MTU0MDc2MTEzMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjExMzEsImF1ZCI6ImI4ZDk4MzUzLTBlYzAtNGU5YS04NDAyLTVhNjllMWY2OTc2ZCIsImp0aSI6IjQ5NDFhMTgyLWNlZDgtNDlhNi1hZTY3LTdlMzQ3YmU3MDgyZCIsInN1YiI6IjNiOTRlZGIwLTJlYWItNDAyYi1hZTg2LThmMjVlMmQzMjQ0OSIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.DSvKplo6e_05xQTaYQkmKHDQuOwrFeM45UG5QAH5WxbMtG5MD715PCt7TzySy49A5cOx-n8JC11sMvRmkkB2UncwGmaNyi_4AWVnLeucYIm1ApED71AlNbn8hMr8uWfnFRXUJfA4acbNr0nI1bRC5tChKohkurV2BvMNq60rsMV4NEgjaXja3t5rqURtPAskirMWtYLNGSnVkkYQp_ou6YcRDHn2AtIBygccJDZBQMsCHuU7la32wZmsKeJisujatAu0gI8SZXSAWjX00EVwCMIJ6_yQkTNNvgSQCmvkT4DOPavFM-dgwnbYO1dst1MbxCuVCGDIZTGdehb8YwvjMw"
+ "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA4NDc3MjIsImlhdCI6MTU0MDc2MTMyMiwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjIsImF1ZCI6IjM2M2U3MzU1LTkzNjQtNGM4NC04MDFmLTA1OWIxZmYyMDNiOCIsImp0aSI6Ijc4NTBhNWIxLWM0NGYtNDUyZi1iMTIyLTUyODc0MzRhZDgyZSIsInN1YiI6ImVkZTJjMzZlLTcwM2QtNDJkMC04MGIzLTNlYzk0ZmMzZDBiMCIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.VsswVZMFJzL-WmwDerdKunYQquFu4jdIVtDdBA04D6Byqt5mjz1ccsxgevWAQNvmyEvCre55hX_vKSmdvgkxoIBbDCAYhsnaePunUU299Zqw7Fi5SCze0vVRZnJpHst9wzkWQby8VPRyVkOBOftpAV7wmawHXKPmpGuuTl5Vsf_g1Sc8imPFnPec-5PZwbia0fclcSrJ0kwNyzu7_ZEEmdANS1gZJMGiTD1BOgw0uzuX02RJIXzWx3VJpsHF2SqHXfxD5oIIXN6dT65ULbthe5_VxUhVs3_ibbQLund-kEaniHsarPsDV6hqDVdBdn-dOgZcf6RnpBCviw9bKm4lFg"
}
```
doc/_posts/2018-10-28-oauth-tokens.markdown
@@ -65,3 +65,18 @@ The Tokens endpoint adheres to [RFC-6749](https://tools.ietf.org/html/rfc6749).
[Section 4.3](https://tools.ietf.org/html/rfc6749#section-4.3)
{% include oauth-tokens-password.html %}
+
+## Client Credentials Grant
+
+```text
+ +---------+ +---------------+
+ | | | |
+ | |>--(A)- Client Authentication --->| Authorization |
+ | Client | | Server |
+ | |<--(B)---- Access Token ---------<| |
+ | | | |
+ +---------+ +---------------+
+```
+[Section 4.4](https://tools.ietf.org/html/rfc6749#section-4.4)
+
+{% include oauth-tokens-client-credentials.html %}
spec/documentation.rb
@@ -59,4 +59,13 @@ RSpec.describe "documentation" do
expect(response.code).to eql('200')
end
end
+
+ specify do
+ headers = { 'Authorization' => ActionController::HttpAuthentication::Basic.encode_credentials(client.to_param, client.password) }
+ body = { grant_type: 'client_credentials' }
+ VCR.use_cassette("oauth-tokens-client-credentials") do
+ response = hippie.post("#{scheme}://#{host}/oauth/tokens", body: body, headers: headers)
+ expect(response.code).to eql('200')
+ end
+ end
end