Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scim2 primary email change #4900

Merged
merged 4 commits into from
Dec 4, 2024
Merged

Scim2 primary email change #4900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b369083
added a note on primary email
himeshsiriwardana Nov 28, 2024
0aac018
Added oneof for IS7 scim apis
himeshsiriwardana Nov 28, 2024
d51d9f4
changed the schema of askPassword attribute
himeshsiriwardana Nov 29, 2024
4e40d13
added askPassword to org APIS
himeshsiriwardana Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 57 additions & 3 deletions en/identity-server/7.0.0/docs/apis/organization-apis/restapis/user-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ paths:
content:
application/scim+json:
schema:
$ref: '#/components/schemas/UserObject'
oneOf:
- $ref: '#/components/schemas/UserObject'
- $ref: '#/components/schemas/UserObjectPassInvite'
required: false
responses:
201:
Expand Down Expand Up @@ -484,6 +486,7 @@ paths:
components:
schemas:
UserObject:
title: Set a password for the user
required:
- password
type: object
Expand All @@ -497,20 +500,26 @@ components:
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
example: kim
description: The `username` you specify will be used by the user for log in.
example: kim
password:
type: string
example: MyPa33w@rd
description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
example: aBcd!23#
emails:
type: array
description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
- type: work
value: [email protected]
items:
Expand All @@ -528,6 +537,51 @@ components:
value:
type: string
example: Taylor
UserObjectPassInvite:
title: Invite the user to set their own password
type: object
properties:
schemas:
type: object
properties: {}
example: []
name:
type: object
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
description: The `userName` you specify will be used by the user for log in.
example: kim
emails:
type: array
description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
items:
type: object
properties: {}
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
type: object
properties:
askPassword:
type: boolean
description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
example: true
manager:
type: object
properties:
value:
type: string
example: Taylor
UserResponseObject:
required:
- meta
Expand Down
58 changes: 56 additions & 2 deletions en/identity-server/7.0.0/docs/apis/restapis/scim2-users.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ paths:
content:
application/scim+json:
schema:
$ref: '#/components/schemas/UserObject'
oneOf:
- $ref: '#/components/schemas/UserObject'
- $ref: '#/components/schemas/UserObjectPassInvite'
required: false
responses:
201:
Expand Down Expand Up @@ -479,6 +481,7 @@ paths:
components:
schemas:
UserObject:
title: Set a password for the user
required:
- password
type: object
Expand All @@ -492,20 +495,26 @@ components:
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
description: The `username` you specify will be used by the user for log in.
example: kim
password:
type: string
example: MyPa33w@rd
description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
example: aBcd!23#
emails:
type: array
description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
- type: work
value: [email protected]
items:
Expand All @@ -523,6 +532,51 @@ components:
value:
type: string
example: Taylor
UserObjectPassInvite:
title: Invite the user to set their own password
type: object
properties:
schemas:
type: object
properties: {}
example: []
name:
type: object
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
description: The `username` you specify will be used by the user for log in.
example: kim
emails:
type: array
description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
items:
type: object
properties: {}
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
type: object
properties:
askPassword:
type: boolean
description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
example: true
manager:
type: object
properties:
value:
type: string
example: Taylor
UserResponseObject:
required:
- meta
Expand Down
60 changes: 57 additions & 3 deletions en/identity-server/next/docs/apis/organization-apis/restapis/user-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ paths:
content:
application/scim+json:
schema:
$ref: '#/components/schemas/UserObject'
oneOf:
- $ref: '#/components/schemas/UserObject'
- $ref: '#/components/schemas/UserObjectPassInvite'
required: false
responses:
201:
Expand Down Expand Up @@ -484,6 +486,7 @@ paths:
components:
schemas:
UserObject:
title: Set a password for the user
required:
- password
type: object
Expand All @@ -497,20 +500,26 @@ components:
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
example: kim
description: The `username` you specify will be used by the user for log in.
example: kim
password:
type: string
example: MyPa33w@rd
description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
example: aBcd!23#
emails:
type: array
description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
- type: work
value: [email protected]
items:
Expand All @@ -528,6 +537,51 @@ components:
value:
type: string
example: Taylor
UserObjectPassInvite:
title: Invite the user to set their own password
type: object
properties:
schemas:
type: object
properties: {}
example: []
name:
type: object
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
description: The `userName` you specify will be used by the user for log in.
example: kim
emails:
type: array
description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
items:
type: object
properties: {}
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
type: object
properties:
askPassword:
type: boolean
description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
example: true
manager:
type: object
properties:
value:
type: string
example: Taylor
UserResponseObject:
required:
- meta
Expand Down
60 changes: 57 additions & 3 deletions en/identity-server/next/docs/apis/restapis/scim2-users.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ paths:
content:
application/scim+json:
schema:
$ref: '#/components/schemas/UserObject'
oneOf:
- $ref: '#/components/schemas/UserObject'
- $ref: '#/components/schemas/UserObjectPassInvite'
required: false
responses:
201:
Expand Down Expand Up @@ -479,6 +481,7 @@ paths:
components:
schemas:
UserObject:
title: Set a password for the user
required:
- password
type: object
Expand All @@ -492,20 +495,26 @@ components:
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
example: kim
description: The `username` you specify will be used by the user for log in.
example: kim
password:
type: string
example: MyPa33w@rd
description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
example: aBcd!23#
emails:
type: array
description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
- type: work
value: [email protected]
items:
Expand All @@ -523,6 +532,51 @@ components:
value:
type: string
example: Taylor
UserObjectPassInvite:
title: Invite the user to set their own password
type: object
properties:
schemas:
type: object
properties: {}
example: []
name:
type: object
properties:
givenName:
type: string
description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
example: Kim
familyName:
type: string
description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
example: Berry
userName:
type: string
description: The `userName` you specify will be used by the user for log in.
example: kim
emails:
type: array
description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
example:
- value: [email protected]
primary: true
items:
type: object
properties: {}
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
type: object
properties:
askPassword:
type: boolean
description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
example: true
manager:
type: object
properties:
value:
type: string
example: Taylor
UserResponseObject:
required:
- meta
Expand Down