Skip to content

Commit a1db848

Browse files
OpenApi: add missing ProtocolIdVerification and associated schemas
1 parent a5d2623 commit a1db848

File tree

1 file changed

+130
-36
lines changed

1 file changed

+130
-36
lines changed

src/swagger/api.yaml

Lines changed: 130 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -53359,6 +53359,86 @@ components:
5335953359
type: array
5336053360
items:
5336153361
type: string
53362+
IDVAuthorizationEndpoint:
53363+
description: IDV authorization endpoint
53364+
type: object
53365+
properties:
53366+
binding:
53367+
type: string
53368+
enum:
53369+
- HTTP-REDIRECT
53370+
url:
53371+
type: string
53372+
description: URL of the IDV `authorization` endpoint
53373+
readOnly: true
53374+
IDVCredentials:
53375+
description: Credentials for verifying requests to the IDV
53376+
type: object
53377+
properties:
53378+
bearer:
53379+
type: object
53380+
description: Client credential for `IDV_PERSONA` IdP type
53381+
properties:
53382+
apiKey:
53383+
type: string
53384+
description: The API key that you generate in your Persona dashboard
53385+
required:
53386+
- apiKey
53387+
client:
53388+
type: object
53389+
description: <x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle>
53390+
<x-lifecycle class="oie"></x-lifecycle></x-lifecycle-container>Client
53391+
credentials for `IDV_CLEAR` and `IDV_INCODE` IdP types
53392+
properties:
53393+
client_id:
53394+
type: string
53395+
description: The client ID that you generate in your IDV
53396+
client_secret:
53397+
type: string
53398+
description: The client secret that you generate in your IDV
53399+
required:
53400+
- client_id
53401+
- client_secret
53402+
x-okta-lifecycle:
53403+
lifecycle: EA
53404+
isGenerallyAvailable: false
53405+
SKUs:
53406+
- Okta Identity Engine
53407+
IDVEndpoints:
53408+
description: Contains the endpoints for the IDV
53409+
type: object
53410+
properties:
53411+
authorization:
53412+
$ref: '#/components/schemas/IDVAuthorizationEndpoint'
53413+
par:
53414+
$ref: '#/components/schemas/IDVParEndpoint'
53415+
token:
53416+
$ref: '#/components/schemas/IDVTokenEndpoint'
53417+
readOnly: true
53418+
IDVParEndpoint:
53419+
description: IDV [PAR](https://datatracker.ietf.org/doc/html/rfc9126) endpoint
53420+
type: object
53421+
properties:
53422+
binding:
53423+
type: string
53424+
enum:
53425+
- HTTP-POST
53426+
url:
53427+
type: string
53428+
description: URL of the IDV `par` endpoint
53429+
readOnly: true
53430+
IDVTokenEndpoint:
53431+
description: IDV token endpoint
53432+
type: object
53433+
properties:
53434+
binding:
53435+
type: string
53436+
enum:
53437+
- HTTP-POST
53438+
url:
53439+
type: string
53440+
description: URL of the IDV `token` endpoint
53441+
readOnly: true
5336253442
IPNetworkZone:
5336353443
allOf:
5336453444
- $ref: '#/components/schemas/NetworkZone'
@@ -53813,28 +53893,31 @@ components:
5381353893
| `YAHOOJP` | [Yahoo Japan](https://login.yahoo.co.jp/config/login)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `profile`, `email` |
5381453894
type: string
5381553895
enum:
53816-
- AMAZON
53817-
- APPLE
53818-
- DISCORD
53819-
- FACEBOOK
53820-
- GITHUB
53821-
- GITLAB
53822-
- GOOGLE
53823-
- LINKEDIN
53824-
- LOGINGOV
53825-
- LOGINGOV_SANDBOX
53826-
- MICROSOFT
53827-
- OIDC
53828-
- PAYPAL
53829-
- PAYPAL_SANDBOX
53830-
- SALESFORCE
53831-
- SAML2
53832-
- SPOTIFY
53833-
- X509
53834-
- XERO
53835-
- YAHOO
53836-
- YAHOOJP
53837-
- OKTA
53896+
- AMAZON
53897+
- APPLE
53898+
- DISCORD
53899+
- FACEBOOK
53900+
- GITHUB
53901+
- GITLAB
53902+
- GOOGLE
53903+
- IDV_CLEAR
53904+
- IDV_INCODE
53905+
- IDV_PERSONA
53906+
- LINKEDIN
53907+
- LOGINGOV
53908+
- LOGINGOV_SANDBOX
53909+
- MICROSOFT
53910+
- OIDC
53911+
- OKTA
53912+
- PAYPAL
53913+
- PAYPAL_SANDBOX
53914+
- SALESFORCE
53915+
- SAML2
53916+
- SPOTIFY
53917+
- X509
53918+
- XERO
53919+
- YAHOO
53920+
- YAHOOJP
5383853921
IdentitySourceSession:
5383953922
type: object
5384053923
properties:
@@ -56771,6 +56854,14 @@ components:
5677156854
- code
5677256855
- id_token
5677356856
- token
56857+
OAuthScopes:
56858+
description: |-
56859+
IdP-defined permission bundles to request delegated access from the user.
56860+
> **Note:** The [identity provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each IdP.
56861+
items:
56862+
type: string
56863+
example: public_profile
56864+
type: array
5677456865
OAuthTokenEndpoint:
5677556866
description: Endpoint for an [OAuth 2.0 Authorization Server (AS)](https://tools.ietf.org/html/rfc6749#page-18)
5677656867
type: object
@@ -60129,6 +60220,7 @@ components:
6012960220
OAUTH2: '#/components/schemas/ProtocolOAuth'
6013060221
OIDC: '#/components/schemas/ProtocolOidc'
6013160222
MTLS: '#/components/schemas/ProtocolMtls'
60223+
ID_PROOFING: "#/components/schemas/ProtocolIdVerification"
6013260224
ProtocolAlgorithmRequestScope:
6013360225
description: Specifies whether to digitally sign authorization requests to the IdP
6013460226
example: REQUEST
@@ -60153,6 +60245,19 @@ components:
6015360245
enum:
6015460246
- HTTP-POST
6015560247
- HTTP-REDIRECT
60248+
ProtocolIdVerification:
60249+
title: ID Verification
60250+
description: Protocol settings for the IDV
60251+
allOf:
60252+
- $ref: '#/components/schemas/Protocol'
60253+
- type: object
60254+
properties:
60255+
credentials:
60256+
$ref: '#/components/schemas/IDVCredentials'
60257+
endpoints:
60258+
$ref: '#/components/schemas/IDVEndpoints'
60259+
scopes:
60260+
$ref: '#/components/schemas/OAuthScopes'
6015660261
ProtocolMtls:
6015760262
title: Mutual TLS Protocol
6015860263
description: Protocol settings for the [MTLS Protocol](https://tools.ietf.org/html/rfc5246#section-7.4.4)
@@ -60176,13 +60281,7 @@ components:
6017660281
endpoints:
6017760282
$ref: '#/components/schemas/OAuthEndpoints'
6017860283
scopes:
60179-
type: array
60180-
description: |-
60181-
IdP-defined permission bundles to request delegated access from the User
60182-
> **Note:** The [Identity Provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each Identity Provider.
60183-
items:
60184-
type: string
60185-
example: public_profile
60284+
$ref: '#/components/schemas/OAuthScopes'
6018660285
ProtocolOidc:
6018760286
title: OpenID Connect Protocol
6018860287
description: Protocol settings for authentication using the [OpenID Connect Protocol](http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)
@@ -60197,13 +60296,7 @@ components:
6019760296
endpoints:
6019860297
$ref: '#/components/schemas/OAuthEndpoints'
6019960298
scopes:
60200-
type: array
60201-
description: |-
60202-
OpenID Connect and IdP-defined permission bundles to request delegated access from the User
60203-
> **Note:** The [Identity Provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each Identity Provider.
60204-
items:
60205-
type: string
60206-
example: openid
60299+
$ref: '#/components/schemas/OAuthScopes'
6020760300
ProtocolSaml:
6020860301
title: SAML 2.0 Protocol
6020960302
description: Protocol settings for the [SAML 2.0 Authentication Request Protocol](http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf)
@@ -60305,6 +60398,7 @@ components:
6030560398
- OAUTH2
6030660399
- OIDC
6030760400
- SAML2
60401+
- ID_PROOFING
6030860402
ProviderType:
6030960403
type: string
6031060404
enum:

0 commit comments

Comments
 (0)