rename Credentials->Profile + Context->Scope (#202)

Co-authored-by: Michael Hoennig <michael@hoennig.de> Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/202 Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>
2025-09-12 11:37:55 +02:00
parent d7d77f60f3
commit bae13d5503
53 changed files with 976 additions and 1080 deletions
@@ -0,0 +1,111 @@
+
+components:
+
+    schemas:
+
+        CurrentLoginUser:
+            type: object
+            properties:
+                subject:
+                    $ref: '../rbac/rbac-subject-schemas.yaml#/components/schemas/RbacSubject'
+                person:
+                    $ref: '../hs-office/hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
+                globalAdmin:
+                    type: boolean
+
+        Profile:
+            type: object
+            properties:
+                uuid:
+                    type: string
+                    format: uuid
+                person:
+                    $ref: '../hs-office/hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
+                nickname:
+                    type: string
+                    pattern: '^[a-z][a-z0-9]{1,8}-[a-z0-9]{1,10}$' # TODO.spec: pattern for login nickname
+                totpSecrets:
+                    type: array
+                    items:
+                        type: string
+                phonePassword:
+                    type: string
+                emailAddress:
+                    type: string
+                smsNumber:
+                    type: string
+                active:
+                    type: boolean
+                globalUid:
+                    type: number
+                globalGid:
+                    type: number
+                scopes:
+                    type: array
+                    items:
+                        $ref: 'scope-schemas.yaml#/components/schemas/Scope'
+            required:
+                - uuid
+                - active
+                - scopes
+            additionalProperties: false
+
+        ProfilePatch:
+            type: object
+            properties:
+                totpSecrets:
+                    type: array
+                    items:
+                        type: string
+                phonePassword:
+                    type: string
+                    nullable: true
+                emailAddress:
+                    type: string
+                    nullable: true
+                smsNumber:
+                    type: string
+                    nullable: true
+                active:
+                    type: boolean
+                scopes:
+                    type: array
+                    items:
+                        $ref: 'scope-schemas.yaml#/components/schemas/Scope'
+            additionalProperties: false
+
+        ProfileInsert:
+            type: object
+            properties:
+                person.uuid:
+                    type: string
+                    format: uuid
+                nickname:
+                    type: string
+                    pattern: '^[a-z][a-z0-9]{1,8}-[a-z0-9]{1,10}$' # TODO.spec: pattern for login nickname
+                emailAddress:
+                    type: string
+                smsNumber:
+                    type: string
+                active:
+                    type: boolean
+                globalUid:
+                    type: number
+                globalGid:
+                    type: number
+                phonePassword:
+                    type: string
+                totpSecrets:
+                    type: array
+                    items:
+                        type: string
+                scopes:
+                    type: array
+                    items:
+                        $ref: 'scope-schemas.yaml#/components/schemas/Scope'
+            required:
+                - person.uuid
+                - nickname
+                - active
+            additionalProperties: false
+