Skip to content

Commit d1721aa

Browse files
OpenApi: Create special Type for SAML Idp Schema
1 parent c74a8ab commit d1721aa

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

src/swagger/api.yaml

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66414,6 +66414,49 @@ components:
6641466414
description: Type of [root Schema](https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.4)
6641566415
_links:
6641666416
$ref: '#/components/schemas/LinksSelf'
66417+
SamlIdpSchema:
66418+
type: object
66419+
properties:
66420+
$schema:
66421+
type: string
66422+
readOnly: true
66423+
description: JSON Schema version identifier
66424+
created:
66425+
type: string
66426+
readOnly: true
66427+
description: Timestamp when the Schema was created
66428+
definitions:
66429+
allOf:
66430+
- $ref: '#/components/schemas/SamlIdpSchemaDefinitions'
66431+
description: |-
66432+
User Profile subschemas
66433+
66434+
The Profile object for a User is defined by a composite Schema of base and custom properties using a JSON path to reference subschemas. The `#base` properties are defined and versioned by Okta, while `#custom` properties are extensible. Custom property names for the Profile object must be unique and can't conflict with a property name defined in the `#base` subschema.
66435+
id:
66436+
type: string
66437+
readOnly: true
66438+
description: URI of User Schema
66439+
lastUpdated:
66440+
type: string
66441+
readOnly: true
66442+
description: Timestamp when the Schema was last updated
66443+
name:
66444+
type: string
66445+
readOnly: true
66446+
description: Name of the Schema
66447+
properties:
66448+
allOf:
66449+
- $ref: '#/components/schemas/UserSchemaProperties'
66450+
description: User Object Properties
66451+
title:
66452+
type: string
66453+
description: User-defined display name for the Schema
66454+
type:
66455+
type: string
66456+
readOnly: true
66457+
description: Type of [root Schema](https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.4)
66458+
_links:
66459+
$ref: '#/components/schemas/LinksSelf'
6641766460
UserSchemaAttribute:
6641866461
type: object
6641966462
properties:
@@ -66778,6 +66821,77 @@ components:
6677866821
allOf:
6677966822
- $ref: '#/components/schemas/UserSchemaAttribute'
6678066823
description: ZIP code or postal code component of the User's address (`postalCode`)
66824+
SamlIdpSchemaBase:
66825+
description: |-
66826+
All Okta-defined Profile properties are defined in a Profile subschema with the resolution scope `#base`. You can't modify these properties, except to update permissions, to change the nullability of `firstName` and `lastName`, or to specify a pattern for `login`. They can't be removed.
66827+
66828+
The base User Profile is based on the [System for Cross-domain Identity Management: Core Schema](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#section-4.1.1) and has the standard properties detailed below.
66829+
type: object
66830+
properties:
66831+
id:
66832+
type: string
66833+
description: The subschema name
66834+
readOnly: true
66835+
properties:
66836+
description: The `#base` object properties
66837+
allOf:
66838+
- $ref: '#/components/schemas/SamlIdpSchemaBaseProperties'
66839+
required:
66840+
type: array
66841+
description: A collection indicating required property names
66842+
readOnly: true
66843+
items:
66844+
type: string
66845+
type:
66846+
type: string
66847+
description: The object type
66848+
readOnly: true
66849+
SamlIdpSchemaBaseProperties:
66850+
type: object
66851+
properties:
66852+
userName:
66853+
allOf:
66854+
- $ref: '#/components/schemas/UserSchemaAttribute'
66855+
description: userName
66856+
subjectNameId:
66857+
allOf:
66858+
- $ref: '#/components/schemas/UserSchemaAttribute'
66859+
description: subjectNameId
66860+
subjectNameFormat:
66861+
allOf:
66862+
- $ref: '#/components/schemas/UserSchemaAttribute'
66863+
description: subjectNameFormat
66864+
subjectNameQualifier:
66865+
allOf:
66866+
- $ref: '#/components/schemas/UserSchemaAttribute'
66867+
description: subjectNameQualifier
66868+
subjectSpProvidedId:
66869+
allOf:
66870+
- $ref: '#/components/schemas/UserSchemaAttribute'
66871+
description: subjectSpProvidedId
66872+
subjectSpNameQualifier:
66873+
allOf:
66874+
- $ref: '#/components/schemas/UserSchemaAttribute'
66875+
description: subjectSpNameQualifier
66876+
subjectConfirmationMethod:
66877+
allOf:
66878+
- $ref: '#/components/schemas/UserSchemaAttribute'
66879+
description: subjectConfirmationMethod
66880+
subjectConfirmationAddress:
66881+
allOf:
66882+
- $ref: '#/components/schemas/UserSchemaAttribute'
66883+
description: subjectConfirmationAddress
66884+
authNContextClassRef:
66885+
allOf:
66886+
- $ref: '#/components/schemas/UserSchemaAttribute'
66887+
description: authNContextClassRef
66888+
SamlIdpSchemaDefinitions:
66889+
type: object
66890+
properties:
66891+
base:
66892+
$ref: '#/components/schemas/SamlIdpSchemaBase'
66893+
custom:
66894+
$ref: '#/components/schemas/UserSchemaPublic'
6678166895
UserSchemaDefinitions:
6678266896
type: object
6678366897
properties:

0 commit comments

Comments
 (0)