Skip to content

Commit f6bb8bf

Browse files
shilpa-padgaonkarhandrews
authored andcommitted
ciba-grant-3.2.0.md
1 parent 4b3b2ce commit f6bb8bf

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

src/oas.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3924,6 +3924,7 @@ Allows configuration of the supported OAuth Flows.
39243924
| <a name="oauth-flows-client-credentials"></a>clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. |
39253925
| <a name="oauth-flows-authorization-code"></a>authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. |
39263926
| <a name="oauth-flows-device-authorization"></s>deviceAuthorization| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Device Authorization flow. |
3927+
| <a name="oauth-flows-ciba"></a>ciba | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OpenID Connect Client-Initiated Backchannel Authentication Flow. |
39273928

39283929
This object MAY be extended with [Specification Extensions](#specification-extensions).
39293930

@@ -3935,11 +3936,14 @@ Configuration details for a supported OAuth Flow
39353936

39363937
| Field Name | Type | Applies To | Description |
39373938
| ---- | :----: | ---- | ---- |
3938-
| <a name="oauth-flow-authorization-url"></a>authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. |
3939+
| <a name="oauth-flow-authorization-url"></a>authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`, `"ciba"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. |
39393940
| <a name="oauth-flow-device-authorization-url"></s>deviceAuthorizationUrl | `string` | `oauth2` (`"deviceAuthorization"`) | **REQUIRED**. The device authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. |
3940-
| <a name="oauth-flow-token-url"></a>tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`, `"deviceAuthorization"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. |
3941+
| <a name="oauth-flow-token-url"></a>tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`, `"deviceAuthorization"`, `"ciba"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. |
39413942
| <a name="oauth-flow-refresh-url"></a>refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. |
39423943
| <a name="oauth-flow-scopes"></a>scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. |
3944+
| <a name="oauth-flow-ciba-delivery-modes"></a>cibaDeliveryModes | Array[`string`] | `oauth2` (`"ciba"`) | **REQUIRED**. JSON array containing one or more of the following values: `poll`, `ping`, and `push`. |
3945+
| <a name="oauth-flow-ciba-signing-algs"></a>cibaSigningAlgs | Array[`string`] | `oauth2` (`"ciba"`) | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP (OpenIdConnect Provider) for signed authentication requests |
3946+
| <a name="oauth-flow-ciba-user-code"></a>cibaUserCode | `boolean` | `oauth2` (`"ciba"`) | Boolean value specifying whether the OP supports the use of the user_code parameter, with true indicating support. If omitted, the default value is false. |
39433947

39443948
This object MAY be extended with [Specification Extensions](#specification-extensions).
39453949

@@ -3963,6 +3967,15 @@ This object MAY be extended with [Specification Extensions](#specification-exten
39633967
"write:pets": "modify pets in your account",
39643968
"read:pets": "read your pets"
39653969
}
3970+
},
3971+
"ciba": {
3972+
"authorizationUrl": "https://example.com/api/oauth/dialog",
3973+
"tokenUrl": "https://example.com/api/oauth/token",
3974+
"scopes": {
3975+
"write:pets": "modify pets in your account",
3976+
"read:pets": "read your pets"
3977+
},
3978+
"cibaDeliveryModes": ["poll"]
39663979
}
39673980
}
39683981
}

0 commit comments

Comments
 (0)