-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release/1.50.0' of github.com:FusionAuth/fusionauth-sit…
…e into release/1.50.0
- Loading branch information
Showing
10 changed files
with
103 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -708,18 +708,7 @@ _Response Codes_ | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response" | ||
| { | ||
| "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "expires_in" : 3600, | ||
| "id_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "refresh_token": "ze9fi6Y9sMSf3yWp3aaO2w7AMav2MFdiMIi2GObrAi-i3248oo0jTQ", | ||
| "refresh_token_id": "4c8927f1-95cd-4bf8-9534-066389ffff5e", | ||
| "scope": "openid offline_access", | ||
| "token_type" : "Bearer", | ||
| "userId" : "3b6d2f70-4821-4694-ac89-60333c9c4165" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response" src="oauth/authorization_code_grant_response.json" /> | ||
|
|
||
| ### Refresh Token Grant Request | ||
|
|
||
|
|
@@ -841,15 +830,7 @@ _Response Codes_ | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response" | ||
| { | ||
| "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "expires_in" : 3600, | ||
| "id_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "token_type" : "Bearer", | ||
| "userId" : "3b6d2f70-4821-4694-ac89-60333c9c4165" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response" src="oauth/refresh_token_grant_response.json" /> | ||
|
|
||
| ### Client Credentials Grant Request | ||
|
|
||
|
|
@@ -1054,16 +1035,7 @@ _Response Codes_ | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response" | ||
| { | ||
| "device_code": "e6f_lF1rG_yroI0DxeQB5OrLDKU18lrDhFXeQqIKAjg", | ||
| "expires_in": 600, | ||
| "interval": 5, | ||
| "user_code": "FBGLLF", | ||
| "verification_uri": "https://piedpiper.com/device", | ||
| "verification_uri_complete": "https://piedpiper.com/device?user_code=FBGLLF" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response" src="oauth/device_authorization_grant_response.json" /> | ||
|
|
||
| ### Device User Code | ||
|
|
||
|
|
@@ -1194,27 +1166,7 @@ _Response Codes_ | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response" | ||
| { | ||
| "client_id": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "deviceInfo": { | ||
| "description": "Johny's Xbox", | ||
| "name": "Xbox", | ||
| "type": "Console" | ||
| }, | ||
| "expires_in": 600, | ||
| "pendingIdPLink": { | ||
| "displayName": "jmoney42", | ||
| "identityProviderId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2", | ||
| "identityProviderName": "Xbox", | ||
| "identityProviderType": "Xbox", | ||
| "identityProviderUserId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2" | ||
| }, | ||
| "scope": "email profile", | ||
| "tenantId": "5f35237d-d036-4aaa-a917-17039d4697e6", | ||
| "user_code": "FBGLLF" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response" src="oauth/device_user_code_response.json" /> | ||
|
|
||
| ### Device Validate | ||
|
|
||
|
|
@@ -1356,25 +1308,7 @@ _Response Codes_ | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response" | ||
| { | ||
| "deviceGrantStatus": "Approved", | ||
| "deviceInfo": { | ||
| "description": "Johny's Xbox", | ||
| "name": "Xbox", | ||
| "type": "Console" | ||
| }, | ||
| "identityProviderLink": { | ||
| "displayName": "jmoney42", | ||
| "identityProviderId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2", | ||
| "identityProviderName": "Xbox", | ||
| "identityProviderType": "Xbox", | ||
| "identityProviderUserId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2" | ||
| }, | ||
| "tenantId": "5f35237d-d036-4aaa-a917-17039d4697e6", | ||
| "userId": "3b6d2f70-4821-4694-ac89-60333c9c4165", | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response" src="oauth/device_approve_response.json" /> | ||
|
|
||
| ## Introspect | ||
|
|
||
|
|
@@ -1519,29 +1453,9 @@ This is an example response body when the provided `access_token` was issued on | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response for a valid token" | ||
| { | ||
| "active": true, | ||
| "applicationId": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "aud": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "authenticationType": "PASSWORD", | ||
| "email": "[email protected]", | ||
| "email_verified": true, | ||
| "exp": 1487975407000, | ||
| "iat": 1487971807000, | ||
| "iss": "acme.com", | ||
| "roles": [ | ||
| "admin" | ||
| ], | ||
| "sub": "858a4b01-62c8-4c2f-bfa7-6d018833bea7" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response for a valid token" src="oauth/introspect_valid_token_response.json" /> | ||
|
|
||
| ```json title="Example JSON Response for an invalid token" | ||
| { | ||
| "active": false | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response for an invalid token" src="oauth/introspect_invalid_token_response.json" /> | ||
|
|
||
| #### Response Body | ||
|
|
||
|
|
@@ -1583,22 +1497,9 @@ This is an example response body when the provided `access_token` was issued as | |
| </APIField> | ||
| </APIBlock> | ||
|
|
||
| ```json title="Example JSON Response for a valid token" | ||
| { | ||
| "active": true, | ||
| "aud": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "exp": 1487975407000, | ||
| "iat": 1487971807000, | ||
| "iss": "acme.com", | ||
| "sub": "858a4b01-62c8-4c2f-bfa7-6d018833bea7" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response for an valid token" src="oauth/introspect_client_credentials_grant_response.json" /> | ||
|
|
||
| ```json title="Example JSON Response for an invalid token" | ||
| { | ||
| "active": false | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response for an invalid token" src="oauth/introspect_invalid_token_response.json" /> | ||
|
|
||
| ## UserInfo | ||
|
|
||
|
|
@@ -1740,14 +1641,7 @@ Errors are either returned in a JSON response body, or as redirect parameters de | |
| When an error is returned from an OAuth endpoint as a JSON body the following structure can be expected in the response. | ||
| The `change_password_id` field will only be present on the response if a password change is required. | ||
|
|
||
| ```json title="Example JSON Response" | ||
| { | ||
| "change_password_id": "a65f7ac3-e4ce-4bf6-bbb0-576189c4d965", | ||
| "error": "change_password_required", | ||
| "error_description": "The user is required to change their password.", | ||
| "error_reason": "change_password_breached" | ||
| } | ||
| ``` | ||
| <JSON title="Example JSON Response" src="oauth/oauth_error_password_change_response.json" /> | ||
|
|
||
| ### Redirect Parameters | ||
|
|
||
|
|
||
10 changes: 10 additions & 0 deletions
10
astro/src/content/json/oauth/authorization_code_grant_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "expires_in" : 3600, | ||
| "id_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "refresh_token": "ze9fi6Y9sMSf3yWp3aaO2w7AMav2MFdiMIi2GObrAi-i3248oo0jTQ", | ||
| "refresh_token_id": "4c8927f1-95cd-4bf8-9534-066389ffff5e", | ||
| "scope": "openid offline_access", | ||
| "token_type" : "Bearer", | ||
| "userId" : "3b6d2f70-4821-4694-ac89-60333c9c4165" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "deviceGrantStatus": "Approved", | ||
| "deviceInfo": { | ||
| "description": "Johny's Xbox", | ||
| "name": "Xbox", | ||
| "type": "Console" | ||
| }, | ||
| "identityProviderLink": { | ||
| "displayName": "jmoney42", | ||
| "identityProviderId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2", | ||
| "identityProviderName": "Xbox", | ||
| "identityProviderType": "Xbox", | ||
| "identityProviderUserId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2" | ||
| }, | ||
| "tenantId": "5f35237d-d036-4aaa-a917-17039d4697e6", | ||
| "userId": "3b6d2f70-4821-4694-ac89-60333c9c4165" | ||
| } |
8 changes: 8 additions & 0 deletions
8
astro/src/content/json/oauth/device_authorization_grant_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "device_code": "e6f_lF1rG_yroI0DxeQB5OrLDKU18lrDhFXeQqIKAjg", | ||
| "expires_in": 600, | ||
| "interval": 5, | ||
| "user_code": "FBGLLF", | ||
| "verification_uri": "https://piedpiper.com/device", | ||
| "verification_uri_complete": "https://piedpiper.com/device?user_code=FBGLLF" | ||
| } |
19 changes: 19 additions & 0 deletions
19
astro/src/content/json/oauth/device_user_code_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "client_id": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "deviceInfo": { | ||
| "description": "Johny's Xbox", | ||
| "name": "Xbox", | ||
| "type": "Console" | ||
| }, | ||
| "expires_in": 600, | ||
| "pendingIdPLink": { | ||
| "displayName": "jmoney42", | ||
| "identityProviderId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2", | ||
| "identityProviderName": "Xbox", | ||
| "identityProviderType": "Xbox", | ||
| "identityProviderUserId": "af53ab21-34c3-468a-8ba2-ecb3905f67f2" | ||
| }, | ||
| "scope": "email profile", | ||
| "tenantId": "5f35237d-d036-4aaa-a917-17039d4697e6", | ||
| "user_code": "FBGLLF" | ||
| } |
8 changes: 8 additions & 0 deletions
8
astro/src/content/json/oauth/introspect_client_credentials_grant_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "active": true, | ||
| "aud": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "exp": 1487975407000, | ||
| "iat": 1487971807000, | ||
| "iss": "acme.com", | ||
| "sub": "858a4b01-62c8-4c2f-bfa7-6d018833bea7" | ||
| } |
3 changes: 3 additions & 0 deletions
3
astro/src/content/json/oauth/introspect_invalid_token_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "active": false | ||
| } |
15 changes: 15 additions & 0 deletions
15
astro/src/content/json/oauth/introspect_valid_token_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "active": true, | ||
| "applicationId": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "aud": "3c219e58-ed0e-4b18-ad48-f4f92793ae32", | ||
| "authenticationType": "PASSWORD", | ||
| "email": "[email protected]", | ||
| "email_verified": true, | ||
| "exp": 1487975407000, | ||
| "iat": 1487971807000, | ||
| "iss": "acme.com", | ||
| "roles": [ | ||
| "admin" | ||
| ], | ||
| "sub": "858a4b01-62c8-4c2f-bfa7-6d018833bea7" | ||
| } |
6 changes: 6 additions & 0 deletions
6
astro/src/content/json/oauth/oauth_error_password_change_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "change_password_id": "a65f7ac3-e4ce-4bf6-bbb0-576189c4d965", | ||
| "error": "change_password_required", | ||
| "error_description": "The user is required to change their password.", | ||
| "error_reason": "change_password_breached" | ||
| } |
7 changes: 7 additions & 0 deletions
7
astro/src/content/json/oauth/refresh_token_grant_response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "expires_in" : 3600, | ||
| "id_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo", | ||
| "token_type" : "Bearer", | ||
| "userId" : "3b6d2f70-4821-4694-ac89-60333c9c4165" | ||
| } |