Document include_scopes query param on GET /api/v2/permissions

.generator/schemas/v2/openapi.yaml

@@ -186259,6 +186259,19 @@ paths:
       description: |-
         Returns a list of all permissions, including name, description, and ID.
       operationId: ListPermissions
+      parameters:
+        - description: |-
+            Set to `true` to return all permissions, including both permissions
+            that can be assigned to user roles and permissions that can only be
+            used as scopes for OAuth clients and scoped credentials. When `false`
+            (default), only permissions that can be assigned to user roles are
+            returned.
+          example: false
+          in: query
+          name: include_scopes
+          required: false
+          schema:
+            type: boolean
       responses:
         "200":
           content:

features/generated-test/test-runner-data/manifest.json

@@ -8596,6 +8596,13 @@
       "scenario": "List permissions for a role returns \"OK\" response",
       "version": "v2"
     },
+    {
+      "feature": "Roles",
+      "feature_file": "../../v2/roles.feature",
+      "file": "v2/roles/list-permissions-including-scopes-returns-ok-response.json",
+      "scenario": "List permissions including scopes returns \"OK\" response",
+      "version": "v2"
+    },
     {
       "feature": "Roles",
       "feature_file": "../../v2/roles.feature",

features/generated-test/test-runner-data/v2/roles/list-permissions-including-scopes-returns-ok-response.json

@@ -0,0 +1,35 @@
+{
+  "api": "Roles",
+  "expected_status": 200,
+  "feature": "Roles",
+  "id": "v2/Roles/List permissions including scopes returns \"OK\" response",
+  "operation_id": "ListPermissions",
+  "request": {
+    "body": null,
+    "content_type": null,
+    "method": "GET",
+    "pagination": false,
+    "parameters": [
+      {
+        "explode": null,
+        "in": "query",
+        "name": "include_scopes",
+        "required": false,
+        "schema": {
+          "format": null,
+          "ref": null,
+          "type": "boolean"
+        },
+        "source": {
+          "type": "literal",
+          "value": true
+        },
+        "style": null
+      }
+    ],
+    "path": "/api/v2/permissions"
+  },
+  "scenario": "List permissions including scopes returns \"OK\" response",
+  "schema_version": 1,
+  "version": "v2"
+}

features/v2/roles.feature

@@ -203,6 +203,14 @@ Feature: Roles
     And the response "data[0].type" is equal to "{{ permission.type }}"
     And the response "data" has item with field "id" with value "{{ permission.id }}"
 
+  @team:DataDog/aaa-core-access @team:DataDog/access-policies-lifecycle
+  Scenario: List permissions including scopes returns "OK" response
+    Given new "ListPermissions" request
+    And request contains "include_scopes" parameter with value true
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "data" has item with field "attributes.name" with value "admin"
+
   @generated @skip @team:DataDog/aaa-core-access @team:DataDog/access-policies-lifecycle
   Scenario: List permissions returns "Bad Request" response
     Given new "ListPermissions" request

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -14480,6 +14480,10 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
     operationResponseType: "OrgGroupResponse",
   },
   "RolesApi.V2.ListPermissions": {
+    includeScopes: {
+      type: "boolean",
+      format: "",
+    },
     operationResponseType: "PermissionsResponse",
   },
   "RolesApi.V2.ListRoles": {

services/roles/README.md

@@ -36,8 +36,9 @@ import { v2 } from "@datadog/datadog-api-client-roles";
 
 const configuration = createConfiguration();
 const apiInstance = new RolesApiV2(configuration);
+const params = {/* parameters */};
 
-apiInstance.listPermissions().then((data) => {
+apiInstance.listPermissions(params).then((data) => {
     console.log("API called successfully. Returned data: " + JSON.stringify(data));
 }).catch((error) => {
     console.error("Error calling API: " + error);

services/roles/src/v2/RolesApi.ts

@@ -399,6 +399,7 @@ export class RolesApiRequestFactory extends BaseAPIRequestFactory {
   }
 
   public async listPermissions(
+    includeScopes?: boolean,
     _options?: Configuration,
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -429,6 +430,15 @@ export class RolesApiRequestFactory extends BaseAPIRequestFactory {
       requestContext.setHeaderParam("X-Datadog-Managed-By", "iac");
     }
 
+    // Query Params
+    if (includeScopes !== undefined) {
+      requestContext.setQueryParam(
+        "include_scopes",
+        serialize(includeScopes, TypingInfo, "boolean", ""),
+        "",
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "apiKeyAuth",
@@ -1781,6 +1791,18 @@ export interface RolesApiGetRoleRequest {
   roleId: string;
 }
 
+export interface RolesApiListPermissionsRequest {
+  /**
+   * Set to `true` to return all permissions, including both permissions
+   * that can be assigned to user roles and permissions that can only be
+   * used as scopes for OAuth clients and scoped credentials. When `false`
+   * (default), only permissions that can be assigned to user roles are
+   * returned.
+   * @type boolean
+   */
+  includeScopes?: boolean;
+}
+
 export interface RolesApiListRolePermissionsRequest {
   /**
    * The unique identifier of the role.
@@ -2051,9 +2073,13 @@ export class RolesApi {
    * @param param The request object
    */
   public listPermissions(
+    param: RolesApiListPermissionsRequest = {},
     options?: Configuration,
   ): Promise<PermissionsResponse> {
-    const requestContextPromise = this.requestFactory.listPermissions(options);
+    const requestContextPromise = this.requestFactory.listPermissions(
+      param.includeScopes,
+      options,
+    );
     return requestContextPromise.then((requestContext) => {
       return this.configuration.httpApi
         .send(requestContext)

services/roles/src/v2/index.ts

@@ -5,6 +5,7 @@ export {
   RolesApiCreateRoleRequest,
   RolesApiDeleteRoleRequest,
   RolesApiGetRoleRequest,
+  RolesApiListPermissionsRequest,
   RolesApiListRolePermissionsRequest,
   RolesApiListRoleUsersRequest,
   RolesApiListRolesRequest,