Automated build 'Automated commit 'Merge pull request #1915 from sail…

…point/DEVREL-1757 Added entitlements as patchable' by github action: 12321210384' go sdk: 12321222640
sailpoint-oss · Dec 13, 2024 · a5b6eac · a5b6eac
1 parent 33aca19
commit a5b6eac
Show file tree

Hide file tree

Showing 8 changed files with 109 additions and 96 deletions.
diff --git a/api_beta/api/openapi.yaml b/api_beta/api/openapi.yaml
@@ -36108,14 +36108,18 @@ paths:
           description: Internal Server Error - Returned if there is an unexpected
             error.
       security:
-      - UserContextAuth:
+      - userAuth:
         - idn:role-unchecked:read
         - idn:role-unchecked:manage
         - idn:role-checked:manage
         - idn:role-checked:read
       summary: List Roles
       tags:
       - Roles
+      x-sailpoint-userLevels:
+      - ORG_ADMIN
+      - ROLE_ADMIN
+      - ROLE_SUBADMIN
     post:
       description: "This API creates a role.\n\nYou must have a token with API, ORG_ADMIN,\
         \ ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. \n\nIn addition,\
@@ -36196,12 +36200,16 @@ paths:
           description: Internal Server Error - Returned if there is an unexpected
             error.
       security:
-      - UserContextAuth:
+      - userAuth:
         - idn:role-unchecked:manage
         - idn:role-checked:manage
       summary: Create a Role
       tags:
       - Roles
+      x-sailpoint-userLevels:
+      - ORG_ADMIN
+      - ROLE_ADMIN
+      - ROLE_SUBADMIN
   /roles/{id}:
     delete:
       description: |-
@@ -36380,17 +36388,18 @@ paths:
     patch:
       description: "This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902)\
         \ syntax.\n\nThe following fields are patchable:\n\n* name\n* description\n\
-        * enabled\n* owner\n* accessProfiles\n* membership\n* requestable\n* accessRequestConfig\n\
-        * revokeRequestConfig\n* segments\n* accessModelMetadata   \nA token with\
-        \ API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call\
-        \ this API. In addition, a token with ROLE_SUBADMIN authority may only call\
-        \ this API if all access profiles included in the role are associated to Sources\
-        \ with management workgroups of which the ROLE_SUBADMIN is a member.\n\nThe\
-        \ maximum supported length for the description field is 2000 characters. Longer\
-        \ descriptions will be preserved for existing roles, however, any new roles\
-        \ as well as any updates to existing descriptions will be limited to 2000\
-        \ characters.\n\nWhen you use this API to modify a role's membership identities,\
-        \ you can only modify up to a limit of 500 membership identities at a time. "
+        * enabled\n* owner\n* accessProfiles\n* entitlements\n* membership\n* requestable\n\
+        * accessRequestConfig\n* revokeRequestConfig\n* segments\n* accessModelMetadata\
+        \   \nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority\
+        \ is required to call this API. In addition, a token with ROLE_SUBADMIN authority\
+        \ may only call this API if all access profiles included in the role are associated\
+        \ to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\n\
+        \nThe maximum supported length for the description field is 2000 characters.\
+        \ Longer descriptions will be preserved for existing roles, however, any new\
+        \ roles as well as any updates to existing descriptions will be limited to\
+        \ 2000 characters.\n\nWhen you use this API to modify a role's membership\
+        \ identities, you can only modify up to a limit of 500 membership identities\
+        \ at a time. "
       operationId: patchRole
       parameters:
       - description: ID of the Role to patch
@@ -36464,7 +36473,7 @@ paths:
                       type: IDENTITY
                       property: attribute.email
                     stringValue: '@identitynow.com'
-              Assign a Access Model Metadata to a role:
+              Assign a Access Model Metadata to a Role:
                 description: This example shows how to assign a existing metadata
                   to a role.
                 value:
@@ -36481,6 +36490,23 @@ paths:
                 - op: replace
                   path: /dimensional
                   value: true
+              Add an Access Profile to a Role:
+                description: This example shows how to add an access profile to a
+                  role.
+                value:
+                - op: add
+                  path: /accessProfiles/-
+                  value:
+                    id: 1de104e1f9024b1289b3a31e22d28cd1
+                    type: ACCESS_PROFILE
+              Add an Entitlement to a Role:
+                description: This example shows how to add an entitlement to a role.
+                value:
+                - op: add
+                  path: /entitlements/-
+                  value:
+                    id: 0fb2f8051e48421b8f1f8a64aee3b205
+                    type: ENTITLEMENT
             schema:
               items:
                 $ref: '#/components/schemas/JsonPatchOperation'

diff --git a/api_beta/api_roles.go b/api_beta/api_roles.go
diff --git a/api_v2024/api/openapi.yaml b/api_v2024/api/openapi.yaml
@@ -24476,11 +24476,6 @@ paths:
         - idn:role-unchecked:manage
         - idn:role-checked:manage
         - idn:role-checked:read
-      - applicationAuth:
-        - idn:role-unchecked:read
-        - idn:role-unchecked:manage
-        - idn:role-checked:manage
-        - idn:role-checked:read
       summary: List Roles
       tags:
       - Roles
@@ -24570,11 +24565,6 @@ paths:
       - userAuth:
         - idn:role-unchecked:manage
         - idn:role-checked:manage
-      - applicationAuth:
-        - idn:role-unchecked:read
-        - idn:role-unchecked:manage
-        - idn:role-checked:manage
-        - idn:role-checked:read
       summary: Create a Role
       tags:
       - Roles
@@ -24661,11 +24651,6 @@ paths:
       - userAuth:
         - idn:role-unchecked:manage
         - idn:role-checked:manage
-      - applicationAuth:
-        - idn:role-unchecked:read
-        - idn:role-unchecked:manage
-        - idn:role-checked:manage
-        - idn:role-checked:read
       summary: Delete a Role
       tags:
       - Roles
@@ -24755,11 +24740,6 @@ paths:
         - idn:role-unchecked:manage
         - idn:role-checked:manage
         - idn:role-checked:read
-      - applicationAuth:
-        - idn:role-unchecked:read
-        - idn:role-unchecked:manage
-        - idn:role-checked:manage
-        - idn:role-checked:read
       summary: Get a Role
       tags:
       - Roles
@@ -24770,16 +24750,16 @@ paths:
     patch:
       description: "This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902)\
         \ syntax.\nThe following fields are patchable:\n* name\n* description\n* enabled\n\
-        * owner\n* accessProfiles\n* membership\n* requestable\n* accessRequestConfig\n\
-        * revokeRequestConfig\n* segments\n* accessModelMetadata\n\nA user with ROLE_SUBADMIN\
-        \ authority may only call this API if all access profiles included in the\
-        \ role are associated to Sources with management workgroups of which the ROLE_SUBADMIN\
-        \ is a member.\n\nThe maximum supported length for the description field is\
-        \ 2000 characters. Longer descriptions will be preserved for existing roles,\
-        \ however, any new roles as well as any updates to existing descriptions will\
-        \ be limited to 2000 characters.\n\nWhen you use this API to modify a role's\
-        \ membership identities, you can only modify up to a limit of 500 membership\
-        \ identities at a time. "
+        * owner\n* accessProfiles\n* entitlements\n* membership\n* requestable\n*\
+        \ accessRequestConfig\n* revokeRequestConfig\n* segments\n* accessModelMetadata\n\
+        \nA user with ROLE_SUBADMIN authority may only call this API if all access\
+        \ profiles included in the role are associated to Sources with management\
+        \ workgroups of which the ROLE_SUBADMIN is a member.\n\nThe maximum supported\
+        \ length for the description field is 2000 characters. Longer descriptions\
+        \ will be preserved for existing roles, however, any new roles as well as\
+        \ any updates to existing descriptions will be limited to 2000 characters.\n\
+        \nWhen you use this API to modify a role's membership identities, you can\
+        \ only modify up to a limit of 500 membership identities at a time. "
       operationId: patchRole
       parameters:
       - description: ID of the Role to patch
@@ -24853,7 +24833,7 @@ paths:
                       type: IDENTITY
                       property: attribute.email
                     stringValue: '@identitynow.com'
-              Assign a Access Model Metadata to a role:
+              Assign a Access Model Metadata to a Role:
                 description: This example shows how to assign a existing metadata
                   to a role.
                 value:
@@ -24863,6 +24843,23 @@ paths:
                     key: iscFederalClassifications
                     values:
                     - value: secret
+              Add an Access Profile to a Role:
+                description: This example shows how to add an access profile to a
+                  role.
+                value:
+                - op: add
+                  path: /accessProfiles/-
+                  value:
+                    id: 1de104e1f9024b1289b3a31e22d28cd1
+                    type: ACCESS_PROFILE
+              Add an Entitlement to a Role:
+                description: This example shows how to add an entitlement to a role.
+                value:
+                - op: add
+                  path: /entitlements/-
+                  value:
+                    id: 0fb2f8051e48421b8f1f8a64aee3b205
+                    type: ENTITLEMENT
             schema:
               items:
                 $ref: '#/components/schemas/JsonPatchOperation'
@@ -24935,11 +24932,6 @@ paths:
       - userAuth:
         - idn:role-unchecked:manage
         - idn:role-checked:manage
-      - applicationAuth:
-        - idn:role-unchecked:read
-        - idn:role-unchecked:manage
-        - idn:role-checked:manage
-        - idn:role-checked:read
       summary: Patch a specified Role
       tags:
       - Roles

diff --git a/api_v2024/api_roles.go b/api_v2024/api_roles.go
diff --git a/api_v2024/docs/RolesAPI.md b/api_v2024/docs/RolesAPI.md
@@ -77,7 +77,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth), [applicationAuth](../README.md#applicationAuth)
+[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth)
 
 ### HTTP request headers
 
@@ -285,7 +285,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth), [applicationAuth](../README.md#applicationAuth)
+[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth)
 
 ### HTTP request headers
 
@@ -486,7 +486,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth), [applicationAuth](../README.md#applicationAuth)
+[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth)
 
 ### HTTP request headers
 
@@ -726,7 +726,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth), [applicationAuth](../README.md#applicationAuth)
+[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth)
 
 ### HTTP request headers
 
@@ -798,7 +798,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth), [applicationAuth](../README.md#applicationAuth)
+[userAuth](../README.md#userAuth), [userAuth](../README.md#userAuth)
 
 ### HTTP request headers