Add Invitations

api/openapi-spec/v1.0.yaml

@@ -1530,6 +1530,28 @@ paths:
           $ref: '#/components/responses/error'
       x-ms-docs-operation-type: operation
 
+  /v1beta1/invitations:
+    post:
+      tags:
+        - invitations
+      summary: Invite a user to the organization
+      operationId: CreateInvitation
+      requestBody:
+        description: New invitation
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/invitation'
+        required: true
+      responses:
+        '201':
+          description: Created invitation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/invitation'
+        default:
+          $ref: '#/components/responses/error'
   /v1.0/users:
     get:
       tags:
@@ -1657,12 +1679,14 @@ paths:
               enum:
                 - id
                 - displayName
+                - givenName
                 - drive
                 - drives
                 - mail
                 - memberOf
                 - onPremisesSamAccountName
                 - surname
+                - userType
               type: string
         - name: $expand
           in: query
@@ -1933,6 +1957,7 @@ paths:
                   displayName: Max Mustermann
                   mail: [email protected]
                   primaryRole: student
+                  userType: Member
                   identities:
                     - issuer: idp.school.com
                       issuerAssignedId: max.mustermann
@@ -2052,6 +2077,7 @@ paths:
                 givenName: Max
                 mail: [email protected]
                 primaryRole: student
+                userType: Member
                 identities:
                   - issuer: idp.school.com
                     issuerAssignedId: max.mustermann
@@ -2266,6 +2292,7 @@ paths:
                   givenName: Max
                   mail: [email protected]
                   primariyRole: student
+                  userType: Member
                   identities:
                     - issuer: idp.school.com
                       issuerAssignedId: max.mustermann
@@ -2620,6 +2647,7 @@ paths:
                   givenName: Max
                   mail: [email protected]
                   primariyRole: student
+                  userType: Member
                   identities:
                     - issuer: idp.school.com
                       issuerAssignedId: max.mustermann
@@ -2722,6 +2750,7 @@ paths:
                   givenName: Max
                   mail: [email protected]
                   primariyRole: teacher
+                  userType: Member
                   identities:
                     - issuer: idp.school.com
                       issuerAssignedId: max.mustermann
@@ -3162,10 +3191,12 @@ components:
           description: The user's givenName. Returned by default.
         primaryRole:
           type: string
+          enum: [student, teacher]
           description: 'The user`s default role. Such as "student" or "teacher"'
         userType:
           type: string
-          description: 'The user`s type. This can be either "Member" for regular user, or "Guest" for guest users.'
+          enum: [Member, Guest]
+          description: 'A string value that can be used to classify user types in your directory, such as ''Member'' and ''Guest''. Returned only on $select. Supports $filter.'
     drive:
       description: The drive represents a space on the storage.
       type: object
@@ -3311,6 +3342,31 @@ components:
         id:
           type: string
           description: Unique identifier for the identity.
+    invitation:
+      type: object
+      required:
+        - invitedUserEmailAddress
+        - inviteRedirectUrl
+      properties:
+        invitedUserDisplayName:
+          type: string
+          description: The display name of the user being invited.
+        invitedUserEmailAddress:
+          type: string
+          description: The email address of the user being invited. Required.
+        inviteRedirectUrl:
+          type: string
+          description: The URL the user should be redirected to once the invitation is redeemed. Required.
+        sendInvitationMessage:
+          type: boolean
+          description: Indicates whether an email should be sent to the user being invited. The default is false.
+        status:
+          type: string
+          enum: [PendingAcceptance, Completed, InProgress, Error]
+          description: 'The status of the invitation. Possible values are: ''PendingAcceptance'', ''Completed'', ''InProgress'', and ''Error''.'
+        invitedUser:
+          $ref: '#/components/schemas/user'
+          description: The user created as part of the invitation creation. Read-Only
     objectIdentity:
       description: Represents an identity used to sign in to a user account
       type: object
@@ -3436,7 +3492,8 @@ components:
           description: The user's givenName. Returned by default.
         userType:
           type: string
-          description: 'The user`s type. This can be either "Member" for regular user, or "Guest" for guest users.'
+          enum: [Member, Guest]
+          description: 'A string value that can be used to classify user types in your directory, such as ''Member'' and ''Guest''. Returned only on $select. Supports $filter.'
         preferredLanguage:
             $ref: '#/components/schemas/language'
     itemReference:
@@ -4634,6 +4691,7 @@ components:
         givenName: Max
         mail: [email protected]
         primaryRole: student
+        userType: Member
         identities:
           - issuer: idp.school.com
             issuerAssignedId: max.mustermann
@@ -4645,6 +4703,7 @@ components:
         givenName: Max
         mail: [email protected]
         primaryRole: student
+        userType: Member
         identities:
           - issuer: idp.school.com
             issuerAssignedId: max.mustermann