Skip to content

Commit d443e8b

Browse files
committed
fix: Remove required fields that are optional in API responses
1 parent cf104e7 commit d443e8b

8 files changed

Lines changed: 570 additions & 408 deletions

.generator/okta-management-APIs-oasv3-noEnums-inheritance.yaml

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -49260,22 +49260,6 @@ components:
4926049260
subjectNameIdTemplate:
4926149261
type: string
4926249262
description: Template for app user's username when a user is assigned to the app
49263-
required:
49264-
- allowMultipleAcsEndpoints
49265-
- assertionSigned
49266-
- audience
49267-
- authnContextClassRef
49268-
- destination
49269-
- digestAlgorithm
49270-
- honorForceAuthn
49271-
- idpIssuer
49272-
- recipient
49273-
- requestCompressed
49274-
- responseSigned
49275-
- signatureAlgorithm
49276-
- ssoAcsUrl
49277-
- subjectNameIdFormat
49278-
- subjectNameIdTemplate
4927949263
SamlAssertionEncryption:
4928049264
description: Determines if the app supports encrypted assertions
4928149265
type: object
@@ -51549,11 +51533,6 @@ components:
5154951533
userNameSelector:
5155051534
type: string
5155151535
description: CSS selector for the **Username** field in the sign-in form (for three-field SWA apps with the `template_swa3field` app name definition)
51552-
required:
51553-
- buttonField
51554-
- passwordField
51555-
- usernameField
51556-
- url
5155751536
TacAuthenticatorEnrollment:
5155851537
type: object
5155951538
properties:
@@ -54205,9 +54184,6 @@ components:
5420554184
$ref: '#/components/schemas/UserIdentifierConditionEvaluatorPattern'
5420654185
type:
5420754186
$ref: '#/components/schemas/UserIdentifierType'
54208-
required:
54209-
- patterns
54210-
- type
5421154187
UserIdentifierType:
5421254188
description: What to match against, either user ID or an attribute in the user's Okta profile.
5421354189
type: string

okta/api/openapi.yaml

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -76331,22 +76331,6 @@ components:
7633176331
description: Template for app user's username when a user is assigned to
7633276332
the app
7633376333
type: string
76334-
required:
76335-
- allowMultipleAcsEndpoints
76336-
- assertionSigned
76337-
- audience
76338-
- authnContextClassRef
76339-
- destination
76340-
- digestAlgorithm
76341-
- honorForceAuthn
76342-
- idpIssuer
76343-
- recipient
76344-
- requestCompressed
76345-
- responseSigned
76346-
- signatureAlgorithm
76347-
- ssoAcsUrl
76348-
- subjectNameIdFormat
76349-
- subjectNameIdTemplate
7635076334
type: object
7635176335
SamlAssertionEncryption:
7635276336
description: Determines if the app supports encrypted assertions
@@ -79633,11 +79617,6 @@ components:
7963379617
description: CSS selector for the **Username** field in the sign-in form
7963479618
(for three-field SWA apps with the `template_swa3field` app name definition)
7963579619
type: string
79636-
required:
79637-
- buttonField
79638-
- passwordField
79639-
- url
79640-
- usernameField
7964179620
type: object
7964279621
TacAuthenticatorEnrollment:
7964379622
example:
@@ -82538,9 +82517,6 @@ components:
8253882517
x-okta-known-values:
8253982518
- ATTRIBUTE
8254082519
- IDENTIFIER
82541-
required:
82542-
- patterns
82543-
- type
8254482520
type: object
8254582521
UserIdentifierType:
8254682522
description: "What to match against, either user ID or an attribute in the user's\

okta/docs/SamlApplicationSettingsSignOn.md

Lines changed: 91 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,41 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**AcsEndpoints** | Pointer to [**[]AcsEndpoint**](AcsEndpoint.md) | An array of ACS endpoints. You can configure a maximum of 100 endpoints. | [optional]
8-
**AllowMultipleAcsEndpoints** | **bool** | Determines whether the app allows you to configure multiple ACS URIs |
8+
**AllowMultipleAcsEndpoints** | Pointer to **bool** | Determines whether the app allows you to configure multiple ACS URIs | [optional]
99
**AssertionEncryption** | Pointer to [**SamlAssertionEncryption**](SamlAssertionEncryption.md) | | [optional]
10-
**AssertionSigned** | **bool** | Determines whether the SAML assertion is digitally signed |
10+
**AssertionSigned** | Pointer to **bool** | Determines whether the SAML assertion is digitally signed | [optional]
1111
**AttributeStatements** | Pointer to [**[]SamlAttributeStatement**](SamlAttributeStatement.md) | A list of custom attribute statements for the app's SAML assertion. See [SAML 2.0 Technical Overview](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.html). There are two types of attribute statements: | Type | Description | | ---- | ----------- | | EXPRESSION | Generic attribute statement that can be dynamic and supports [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language/) | | GROUP | Group attribute statement | | [optional]
12-
**Audience** | **string** | The entity ID of the SP. Use the entity ID value exactly as provided by the SP. |
12+
**Audience** | Pointer to **string** | The entity ID of the SP. Use the entity ID value exactly as provided by the SP. | [optional]
1313
**AudienceOverride** | Pointer to **string** | Audience override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm). | [optional]
14-
**AuthnContextClassRef** | **string** | Identifies the SAML authentication context class for the assertion's authentication statement |
14+
**AuthnContextClassRef** | Pointer to **string** | Identifies the SAML authentication context class for the assertion's authentication statement | [optional]
1515
**ConfiguredAttributeStatements** | Pointer to [**[]SamlAttributeStatement**](SamlAttributeStatement.md) | The list of dynamic attribute statements for the SAML assertion inherited from app metadata (apps from the OIN) during app creation. There are two types of attribute statements: `EXPRESSION` and `GROUP`. | [optional]
1616
**DefaultRelayState** | Pointer to **string** | Identifies a specific application resource in an IdP-initiated SSO scenario | [optional]
17-
**Destination** | **string** | Identifies the location inside the SAML assertion where the SAML response should be sent |
17+
**Destination** | Pointer to **string** | Identifies the location inside the SAML assertion where the SAML response should be sent | [optional]
1818
**DestinationOverride** | Pointer to **string** | Destination override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm). | [optional]
19-
**DigestAlgorithm** | **string** | Determines the digest algorithm used to digitally sign the SAML assertion and response |
20-
**HonorForceAuthn** | **bool** | Set to `true` to prompt users for their credentials when a SAML request has the `ForceAuthn` attribute set to `true` |
21-
**IdpIssuer** | **string** | SAML Issuer ID |
19+
**DigestAlgorithm** | Pointer to **string** | Determines the digest algorithm used to digitally sign the SAML assertion and response | [optional]
20+
**HonorForceAuthn** | Pointer to **bool** | Set to `true` to prompt users for their credentials when a SAML request has the `ForceAuthn` attribute set to `true` | [optional]
21+
**IdpIssuer** | Pointer to **string** | SAML Issuer ID | [optional]
2222
**InlineHooks** | Pointer to [**[]SignOnInlineHook**](SignOnInlineHook.md) | Associates the app with SAML inline hooks. See [the SAML assertion inline hook reference](https://developer.okta.com/docs/reference/saml-hook/). | [optional]
2323
**ParticipateSlo** | Pointer to [**SloParticipate**](SloParticipate.md) | | [optional]
24-
**Recipient** | **string** | The location where the app may present the SAML assertion |
24+
**Recipient** | Pointer to **string** | The location where the app may present the SAML assertion | [optional]
2525
**RecipientOverride** | Pointer to **string** | Recipient override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm). | [optional]
26-
**RequestCompressed** | **bool** | Determines whether the SAML request is expected to be compressed |
27-
**ResponseSigned** | **bool** | Determines whether the SAML authentication response message is digitally signed by the IdP > **Note:** Either (or both) `responseSigned` or `assertionSigned` must be `TRUE`. |
26+
**RequestCompressed** | Pointer to **bool** | Determines whether the SAML request is expected to be compressed | [optional]
27+
**ResponseSigned** | Pointer to **bool** | Determines whether the SAML authentication response message is digitally signed by the IdP > **Note:** Either (or both) `responseSigned` or `assertionSigned` must be `TRUE`. | [optional]
2828
**SamlAssertionLifetimeSeconds** | Pointer to **int32** | Determines the SAML app session lifetimes with Okta | [optional]
29-
**SignatureAlgorithm** | **string** | Determines the signing algorithm used to digitally sign the SAML assertion and response |
29+
**SignatureAlgorithm** | Pointer to **string** | Determines the signing algorithm used to digitally sign the SAML assertion and response | [optional]
3030
**Slo** | Pointer to [**SingleLogout**](SingleLogout.md) | | [optional]
3131
**SpCertificate** | Pointer to [**SamlSpCertificate**](SamlSpCertificate.md) | | [optional]
3232
**SpIssuer** | Pointer to **string** | The issuer ID for the Service Provider. This property appears when SLO is enabled. | [optional]
33-
**SsoAcsUrl** | **string** | Single Sign-On Assertion Consumer Service (ACS) URL |
33+
**SsoAcsUrl** | Pointer to **string** | Single Sign-On Assertion Consumer Service (ACS) URL | [optional]
3434
**SsoAcsUrlOverride** | Pointer to **string** | Assertion Consumer Service (ACS) URL override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm). | [optional]
35-
**SubjectNameIdFormat** | **string** | Identifies the SAML processing rules. Supported values: |
36-
**SubjectNameIdTemplate** | **string** | Template for app user's username when a user is assigned to the app |
35+
**SubjectNameIdFormat** | Pointer to **string** | Identifies the SAML processing rules. Supported values: | [optional]
36+
**SubjectNameIdTemplate** | Pointer to **string** | Template for app user's username when a user is assigned to the app | [optional]
3737

3838
## Methods
3939

4040
### NewSamlApplicationSettingsSignOn
4141

42-
`func NewSamlApplicationSettingsSignOn(allowMultipleAcsEndpoints bool, assertionSigned bool, audience string, authnContextClassRef string, destination string, digestAlgorithm string, honorForceAuthn bool, idpIssuer string, recipient string, requestCompressed bool, responseSigned bool, signatureAlgorithm string, ssoAcsUrl string, subjectNameIdFormat string, subjectNameIdTemplate string, ) *SamlApplicationSettingsSignOn`
42+
`func NewSamlApplicationSettingsSignOn() *SamlApplicationSettingsSignOn`
4343

4444
NewSamlApplicationSettingsSignOn instantiates a new SamlApplicationSettingsSignOn object
4545
This constructor will assign default values to properties that have it defined,
@@ -98,6 +98,11 @@ and a boolean to check if the value has been set.
9898

9999
SetAllowMultipleAcsEndpoints sets AllowMultipleAcsEndpoints field to given value.
100100

101+
### HasAllowMultipleAcsEndpoints
102+
103+
`func (o *SamlApplicationSettingsSignOn) HasAllowMultipleAcsEndpoints() bool`
104+
105+
HasAllowMultipleAcsEndpoints returns a boolean if a field has been set.
101106

102107
### GetAssertionEncryption
103108

@@ -143,6 +148,11 @@ and a boolean to check if the value has been set.
143148

144149
SetAssertionSigned sets AssertionSigned field to given value.
145150

151+
### HasAssertionSigned
152+
153+
`func (o *SamlApplicationSettingsSignOn) HasAssertionSigned() bool`
154+
155+
HasAssertionSigned returns a boolean if a field has been set.
146156

147157
### GetAttributeStatements
148158

@@ -188,6 +198,11 @@ and a boolean to check if the value has been set.
188198

189199
SetAudience sets Audience field to given value.
190200

201+
### HasAudience
202+
203+
`func (o *SamlApplicationSettingsSignOn) HasAudience() bool`
204+
205+
HasAudience returns a boolean if a field has been set.
191206

192207
### GetAudienceOverride
193208

@@ -233,6 +248,11 @@ and a boolean to check if the value has been set.
233248

234249
SetAuthnContextClassRef sets AuthnContextClassRef field to given value.
235250

251+
### HasAuthnContextClassRef
252+
253+
`func (o *SamlApplicationSettingsSignOn) HasAuthnContextClassRef() bool`
254+
255+
HasAuthnContextClassRef returns a boolean if a field has been set.
236256

237257
### GetConfiguredAttributeStatements
238258

@@ -303,6 +323,11 @@ and a boolean to check if the value has been set.
303323

304324
SetDestination sets Destination field to given value.
305325

326+
### HasDestination
327+
328+
`func (o *SamlApplicationSettingsSignOn) HasDestination() bool`
329+
330+
HasDestination returns a boolean if a field has been set.
306331

307332
### GetDestinationOverride
308333

@@ -348,6 +373,11 @@ and a boolean to check if the value has been set.
348373

349374
SetDigestAlgorithm sets DigestAlgorithm field to given value.
350375

376+
### HasDigestAlgorithm
377+
378+
`func (o *SamlApplicationSettingsSignOn) HasDigestAlgorithm() bool`
379+
380+
HasDigestAlgorithm returns a boolean if a field has been set.
351381

352382
### GetHonorForceAuthn
353383

@@ -368,6 +398,11 @@ and a boolean to check if the value has been set.
368398

369399
SetHonorForceAuthn sets HonorForceAuthn field to given value.
370400

401+
### HasHonorForceAuthn
402+
403+
`func (o *SamlApplicationSettingsSignOn) HasHonorForceAuthn() bool`
404+
405+
HasHonorForceAuthn returns a boolean if a field has been set.
371406

372407
### GetIdpIssuer
373408

@@ -388,6 +423,11 @@ and a boolean to check if the value has been set.
388423

389424
SetIdpIssuer sets IdpIssuer field to given value.
390425

426+
### HasIdpIssuer
427+
428+
`func (o *SamlApplicationSettingsSignOn) HasIdpIssuer() bool`
429+
430+
HasIdpIssuer returns a boolean if a field has been set.
391431

392432
### GetInlineHooks
393433

@@ -458,6 +498,11 @@ and a boolean to check if the value has been set.
458498

459499
SetRecipient sets Recipient field to given value.
460500

501+
### HasRecipient
502+
503+
`func (o *SamlApplicationSettingsSignOn) HasRecipient() bool`
504+
505+
HasRecipient returns a boolean if a field has been set.
461506

462507
### GetRecipientOverride
463508

@@ -503,6 +548,11 @@ and a boolean to check if the value has been set.
503548

504549
SetRequestCompressed sets RequestCompressed field to given value.
505550

551+
### HasRequestCompressed
552+
553+
`func (o *SamlApplicationSettingsSignOn) HasRequestCompressed() bool`
554+
555+
HasRequestCompressed returns a boolean if a field has been set.
506556

507557
### GetResponseSigned
508558

@@ -523,6 +573,11 @@ and a boolean to check if the value has been set.
523573

524574
SetResponseSigned sets ResponseSigned field to given value.
525575

576+
### HasResponseSigned
577+
578+
`func (o *SamlApplicationSettingsSignOn) HasResponseSigned() bool`
579+
580+
HasResponseSigned returns a boolean if a field has been set.
526581

527582
### GetSamlAssertionLifetimeSeconds
528583

@@ -568,6 +623,11 @@ and a boolean to check if the value has been set.
568623

569624
SetSignatureAlgorithm sets SignatureAlgorithm field to given value.
570625

626+
### HasSignatureAlgorithm
627+
628+
`func (o *SamlApplicationSettingsSignOn) HasSignatureAlgorithm() bool`
629+
630+
HasSignatureAlgorithm returns a boolean if a field has been set.
571631

572632
### GetSlo
573633

@@ -663,6 +723,11 @@ and a boolean to check if the value has been set.
663723

664724
SetSsoAcsUrl sets SsoAcsUrl field to given value.
665725

726+
### HasSsoAcsUrl
727+
728+
`func (o *SamlApplicationSettingsSignOn) HasSsoAcsUrl() bool`
729+
730+
HasSsoAcsUrl returns a boolean if a field has been set.
666731

667732
### GetSsoAcsUrlOverride
668733

@@ -708,6 +773,11 @@ and a boolean to check if the value has been set.
708773

709774
SetSubjectNameIdFormat sets SubjectNameIdFormat field to given value.
710775

776+
### HasSubjectNameIdFormat
777+
778+
`func (o *SamlApplicationSettingsSignOn) HasSubjectNameIdFormat() bool`
779+
780+
HasSubjectNameIdFormat returns a boolean if a field has been set.
711781

712782
### GetSubjectNameIdTemplate
713783

@@ -728,6 +798,11 @@ and a boolean to check if the value has been set.
728798

729799
SetSubjectNameIdTemplate sets SubjectNameIdTemplate field to given value.
730800

801+
### HasSubjectNameIdTemplate
802+
803+
`func (o *SamlApplicationSettingsSignOn) HasSubjectNameIdTemplate() bool`
804+
805+
HasSubjectNameIdTemplate returns a boolean if a field has been set.
731806

732807

733808
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)