Skip to content

Commit 314d900

Browse files
committed
Update openapi spec
1 parent 3842bad commit 314d900

File tree

1 file changed

+253
-0
lines changed

1 file changed

+253
-0
lines changed

openapi.json

Lines changed: 253 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3640,6 +3640,259 @@
36403640
}
36413641
}
36423642
},
3643+
"/ListContactPermissions": {
3644+
"get": {
3645+
"description": "ListContactPermissions - Retrieves contact folder permissions for a specified user",
3646+
"summary": "ListContactPermissions",
3647+
"tags": [
3648+
"GET"
3649+
],
3650+
"parameters": [
3651+
{
3652+
"required": true,
3653+
"schema": {
3654+
"type": "string"
3655+
},
3656+
"name": "UserID",
3657+
"in": "query",
3658+
"description": "The user ID to retrieve contact permissions for"
3659+
},
3660+
{
3661+
"required": true,
3662+
"schema": {
3663+
"type": "string"
3664+
},
3665+
"name": "tenantFilter",
3666+
"in": "query",
3667+
"description": "The tenant filter to specify which tenant"
3668+
}
3669+
],
3670+
"responses": {
3671+
"200": {
3672+
"content": {
3673+
"application/json": {
3674+
"schema": {
3675+
"type": "array",
3676+
"items": {
3677+
"type": "object",
3678+
"properties": {
3679+
"Identity": {
3680+
"type": "string",
3681+
"description": "The identity of the contact folder"
3682+
},
3683+
"User": {
3684+
"type": "string",
3685+
"description": "The user who has permissions"
3686+
},
3687+
"AccessRights": {
3688+
"type": "array",
3689+
"items": {
3690+
"type": "string"
3691+
},
3692+
"description": "The access rights granted to the user"
3693+
},
3694+
"FolderName": {
3695+
"type": "string",
3696+
"description": "The name of the contact folder"
3697+
},
3698+
"MailboxInfo": {
3699+
"type": "object",
3700+
"description": "Information about the mailbox"
3701+
}
3702+
}
3703+
}
3704+
}
3705+
}
3706+
},
3707+
"description": "Successfully retrieved contact permissions"
3708+
},
3709+
"403": {
3710+
"content": {
3711+
"application/json": {
3712+
"schema": {
3713+
"type": "object",
3714+
"properties": {
3715+
"error": {
3716+
"type": "string",
3717+
"description": "Error message"
3718+
}
3719+
}
3720+
}
3721+
}
3722+
},
3723+
"description": "Forbidden - insufficient permissions"
3724+
}
3725+
}
3726+
}
3727+
},
3728+
"/ExecModifyContactPerms": {
3729+
"post": {
3730+
"description": "ExecModifyContactPerms - Modifies contact folder permissions for a specified user",
3731+
"summary": "ExecModifyContactPerms",
3732+
"tags": [
3733+
"POST"
3734+
],
3735+
"requestBody": {
3736+
"required": true,
3737+
"content": {
3738+
"application/json": {
3739+
"schema": {
3740+
"type": "object",
3741+
"required": [
3742+
"userID",
3743+
"tenantFilter",
3744+
"permissions"
3745+
],
3746+
"properties": {
3747+
"userID": {
3748+
"type": "string",
3749+
"description": "The user ID whose contact permissions will be modified"
3750+
},
3751+
"tenantFilter": {
3752+
"type": "string",
3753+
"description": "The tenant filter to specify which tenant"
3754+
},
3755+
"permissions": {
3756+
"type": "array",
3757+
"description": "Array of permission objects to apply",
3758+
"items": {
3759+
"type": "object",
3760+
"properties": {
3761+
"PermissionLevel": {
3762+
"type": "object",
3763+
"properties": {
3764+
"value": {
3765+
"type": "string",
3766+
"description": "Permission level (e.g., Owner, PublishingEditor, Editor, PublishingAuthor, Author, NonEditingAuthor, Reviewer, Contributor, AvailabilityOnly, LimitedDetails)"
3767+
}
3768+
}
3769+
},
3770+
"Modification": {
3771+
"type": "string",
3772+
"description": "Type of modification (Add, Remove)",
3773+
"enum": ["Add", "Remove"]
3774+
},
3775+
"UserID": {
3776+
"type": "array",
3777+
"description": "Array of target users to grant/remove permissions",
3778+
"items": {
3779+
"type": "object",
3780+
"properties": {
3781+
"value": {
3782+
"type": "string",
3783+
"description": "User ID or email address"
3784+
}
3785+
}
3786+
}
3787+
},
3788+
"CanViewPrivateItems": {
3789+
"type": "boolean",
3790+
"description": "Whether the user can view private items",
3791+
"default": false
3792+
},
3793+
"FolderName": {
3794+
"type": "string",
3795+
"description": "Name of the contact folder",
3796+
"default": "Contact"
3797+
},
3798+
"SendNotificationToUser": {
3799+
"type": "boolean",
3800+
"description": "Whether to send notification to the user",
3801+
"default": false
3802+
}
3803+
},
3804+
"required": [
3805+
"PermissionLevel",
3806+
"Modification",
3807+
"UserID"
3808+
]
3809+
}
3810+
}
3811+
}
3812+
}
3813+
}
3814+
}
3815+
},
3816+
"responses": {
3817+
"200": {
3818+
"content": {
3819+
"application/json": {
3820+
"schema": {
3821+
"type": "object",
3822+
"properties": {
3823+
"Results": {
3824+
"type": "array",
3825+
"items": {
3826+
"type": "string"
3827+
},
3828+
"description": "Array of result messages for each permission operation"
3829+
}
3830+
}
3831+
}
3832+
}
3833+
},
3834+
"description": "Successfully processed contact permission modifications"
3835+
},
3836+
"400": {
3837+
"content": {
3838+
"application/json": {
3839+
"schema": {
3840+
"type": "object",
3841+
"properties": {
3842+
"Results": {
3843+
"type": "array",
3844+
"items": {
3845+
"type": "string"
3846+
},
3847+
"description": "Error messages"
3848+
}
3849+
}
3850+
}
3851+
}
3852+
},
3853+
"description": "Bad Request - Missing required parameters"
3854+
},
3855+
"404": {
3856+
"content": {
3857+
"application/json": {
3858+
"schema": {
3859+
"type": "object",
3860+
"properties": {
3861+
"Results": {
3862+
"type": "array",
3863+
"items": {
3864+
"type": "string"
3865+
},
3866+
"description": "Error messages"
3867+
}
3868+
}
3869+
}
3870+
}
3871+
},
3872+
"description": "Not Found - User ID not found"
3873+
},
3874+
"500": {
3875+
"content": {
3876+
"application/json": {
3877+
"schema": {
3878+
"type": "object",
3879+
"properties": {
3880+
"Results": {
3881+
"type": "array",
3882+
"items": {
3883+
"type": "string"
3884+
},
3885+
"description": "Error messages"
3886+
}
3887+
}
3888+
}
3889+
}
3890+
},
3891+
"description": "Internal Server Error - Operation failed"
3892+
}
3893+
}
3894+
}
3895+
},
36433896
"/ListMailboxRules": {
36443897
"get": {
36453898
"description": "ListMailboxRules",

0 commit comments

Comments
 (0)