### Users API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing users within the system. ```APIDOC ## GET /api/Users ### Description This endpoint is deprecated. Use /api/Users/WithPagination instead. ### Method GET ### Endpoint /api/Users ### Response This endpoint is deprecated and will not return data. ``` ```APIDOC ## POST /api/Users ### Description Create a new user. ### Method POST ### Endpoint /api/Users ### Parameters #### Request Body - **user** (object) - Required - The user object to create. - **email** (string) - Required - The email address of the user. - **firstName** (string) - Required - The first name of the user. - **lastName** (string) - Required - The last name of the user. ### Request Example { "user": { "email": "test@example.com", "firstName": "John", "lastName": "Doe" } } ### Response #### Success Response (200) - **userId** (string) - The ID of the newly created user. #### Response Example { "userId": "generated-user-id" } ``` ```APIDOC ## GET /api/Users/WithPagination ### Description Get the list of users with pagination. ### Method GET ### Endpoint /api/Users/WithPagination ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number to retrieve. - **pageSize** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **users** (array) - A list of user objects. - **totalCount** (integer) - The total number of users available. #### Response Example { "users": [ { "userId": "user-id-1", "email": "user1@example.com", "firstName": "User", "lastName": "One" } ], "totalCount": 100 } ``` ```APIDOC ## GET /api/Users/search-by-email ### Description Search user by email. ### Method GET ### Endpoint /api/Users/search-by-email ### Parameters #### Query Parameters - **email** (string) - Required - The email address to search for. ### Response #### Success Response (200) - **user** (object) - The user object matching the email. #### Response Example { "user": { "userId": "user-id-1", "email": "search.user@example.com", "firstName": "Search", "lastName": "User" } } ``` ```APIDOC ## GET /api/Users/{userId} ### Description Get a specific user. ### Method GET ### Endpoint /api/Users/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user to retrieve. ### Response #### Success Response (200) - **user** (object) - The user object. #### Response Example { "user": { "userId": "specific-user-id", "email": "specific@example.com", "firstName": "Specific", "lastName": "User" } } ``` ```APIDOC ## PUT /api/Users/{userId} ### Description Update an existing user. ### Method PUT ### Endpoint /api/Users/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user to update. #### Request Body - **user** (object) - Required - The updated user object. - **email** (string) - Optional - The updated email address of the user. - **firstName** (string) - Optional - The updated first name of the user. - **lastName** (string) - Optional - The updated last name of the user. ### Request Example { "user": { "firstName": "UpdatedFirstName", "lastName": "UpdatedLastName" } } ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating successful update. #### Response Example { "message": "User updated successfully." } ``` ```APIDOC ## DELETE /api/Users/{userId} ### Description Delete an existing user. ### Method DELETE ### Endpoint /api/Users/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user to delete. ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating successful deletion. #### Response Example { "message": "User deleted successfully." } ``` -------------------------------- ### FilesAccess API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing file access permissions for users and groups. ```APIDOC ## GET /api/FilesAccess/WithPagination ### Description Retrieves a paginated list of file access associations. ### Method GET ### Endpoint /api/FilesAccess/WithPagination ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number for pagination. - **pageSize** (integer) - Optional - The number of items per page. ### Request Example ### Response #### Success Response (200) - **fileAccesses** (array) - A list of file access objects. - **userId** (integer) - The ID of the user. - **groupId** (integer) - The ID of the group. - **fileId** (integer) - The ID of the file. #### Response Example { "fileAccesses": [ { "userId": 1, "groupId": null, "fileId": 101 }, { "userId": null, "groupId": 5, "fileId": 102 } ] } ``` ```APIDOC ## POST /api/FilesAccess/users/{userId}/{fileId} ### Description Creates file access for a user to a specific file. ### Method POST ### Endpoint /api/FilesAccess/users/{userId}/{fileId} ### Parameters #### Path Parameters - **userId** (integer) - Required - The ID of the user. - **fileId** (integer) - Required - The ID of the file. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of successful access creation. #### Response Example { "message": "User 1 granted access to file 101." } ``` ```APIDOC ## DELETE /api/FilesAccess/users/{userId}/{fileId} ### Description Deletes file access for a user to a specific file. ### Method DELETE ### Endpoint /api/FilesAccess/users/{userId}/{fileId} ### Parameters #### Path Parameters - **userId** (integer) - Required - The ID of the user. - **fileId** (integer) - Required - The ID of the file. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of successful access deletion. #### Response Example { "message": "User 1 access to file 101 revoked." } ``` ```APIDOC ## POST /api/FilesAccess/groups/{groupId}/{fileId} ### Description Creates file access for a group to a specific file. ### Method POST ### Endpoint /api/FilesAccess/groups/{groupId}/{fileId} ### Parameters #### Path Parameters - **groupId** (integer) - Required - The ID of the group. - **fileId** (integer) - Required - The ID of the file. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of successful access creation. #### Response Example { "message": "Group 5 granted access to file 102." } ``` ```APIDOC ## DELETE /api/FilesAccess/groups/{groupId}/{fileId} ### Description Deletes file access for a group to a specific file. ### Method DELETE ### Endpoint /api/FilesAccess/groups/{groupId}/{fileId} ### Parameters #### Path Parameters - **groupId** (integer) - Required - The ID of the group. - **fileId** (integer) - Required - The ID of the file. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of successful access deletion. #### Response Example { "message": "Group 5 access to file 102 revoked." } ``` -------------------------------- ### Token Authentication API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoint for obtaining an authentication token. ```APIDOC ## POST /api/auth/token ### Description Token endpoint for authentication. Use the returned token as 'Bearer {token}' in the Authorize button above for authenticated requests. ### Method POST ### Endpoint /api/auth/token ### Parameters #### Request Body - **credentials** (object) - Required - The user's authentication credentials. - **username** (string) - Required - The username for authentication. - **password** (string) - Required - The password for authentication. ### Request Example { "credentials": { "username": "user@example.com", "password": "securepassword123" } } ### Response #### Success Response (200) - **token** (string) - The authentication token. #### Response Example { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." } ``` -------------------------------- ### PlaylistsAccess API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing playlist access permissions. ```APIDOC ## GET /api/PlaylistsAccess ### Description Retrieves a paginated list of playlist accesses. ### Method GET ### Endpoint /api/PlaylistsAccess ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number for pagination. - **pageSize** (integer) - Optional - The number of items per page. ### Request Example ### Response #### Success Response (200) - **playlistAccess ``` -------------------------------- ### Files API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing files, including retrieval, creation, update, and deletion. ```APIDOC ## GET /api/Files/WithPagination ### Description Retrieves a paginated list of files. ### Method GET ### Endpoint /api/Files/WithPagination ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number for pagination. - **pageSize** (integer) - Optional - The number of items per page. ### Request Example ### Response #### Success Response (200) - **files** (array) - A list of file objects. - **fileId** (integer) - The unique identifier for the file. - **fileName** (string) - The name of the file. - **uploadDate** (string) - The date the file was uploaded. #### Response Example { "files": [ { "fileId": 101, "fileName": "report.pdf", "uploadDate": "2023-10-26T14:30:00Z" } ] } ``` ```APIDOC ## GET /api/Files/{fileId} ### Description Retrieves a specific file by its ID. ### Method GET ### Endpoint /api/Files/{fileId} ### Parameters #### Path Parameters - **fileId** (integer) - Required - The ID of the file to retrieve. ### Request Example ### Response #### Success Response (200) - **fileId** (integer) - The unique identifier for the file. - **fileName** (string) - The name of the file. - **uploadDate** (string) - The date the file was uploaded. #### Response Example { "fileId": 101, "fileName": "report.pdf", "uploadDate": "2023-10-26T14:30:00Z" } ``` ```APIDOC ## PUT /api/Files/{fileId} ### Description Updates an existing file's data. ### Method PUT ### Endpoint /api/Files/{fileId} ### Parameters #### Path Parameters - **fileId** (integer) - Required - The ID of the file to update. #### Request Body - **fileName** (string) - Optional - The new name for the file. ### Request Example { "fileName": "updated_report.pdf" } ### Response #### Success Response (200) - **fileId** (integer) - The ID of the updated file. - **fileName** (string) - The updated name of the file. - **uploadDate** (string) - The upload date of the file. #### Response Example { "fileId": 101, "fileName": "updated_report.pdf", "uploadDate": "2023-10-26T14:30:00Z" } ``` ```APIDOC ## DELETE /api/Files/{fileId} ### Description Deletes a file by its ID. ### Method DELETE ### Endpoint /api/Files/{fileId} ### Parameters #### Path Parameters - **fileId** (integer) - Required - The ID of the file to delete. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of deletion. #### Response Example { "message": "File with ID 101 deleted successfully." } ``` ```APIDOC ## POST /api/Files ### Description Creates a new file. ### Method POST ### Endpoint /api/Files ### Parameters #### Request Body - **fileName** (string) - Required - The name of the file to create. - **fileContent** (string) - Required - The content of the file (base64 encoded or similar). ### Request Example { "fileName": "new_document.docx", "fileContent": "UEsDBAoAAAAA..." } ### Response #### Success Response (200) - **fileId** (integer) - The ID of the newly created file. - **fileName** (string) - The name of the new file. - **uploadDate** (string) - The upload date of the new file. #### Response Example { "fileId": 102, "fileName": "new_document.docx", "uploadDate": "2023-10-27T09:00:00Z" } ``` -------------------------------- ### Playlists API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing playlists, including retrieval, creation, update, and deletion. ```APIDOC ## GET /api/Playlists/WithPagination ### Description Retrieves a paginated list of playlists. ### Method GET ### Endpoint /api/Playlists/WithPagination ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number for pagination. - **pageSize** (integer) - Optional - The number of items per page. ### Request Example ### Response #### Success Response (200) - **playlists** (array) - A list of playlist objects. - **playlistId** (integer) - The unique identifier for the playlist. - **name** (string) - The name of the playlist. #### Response Example { "playlists": [ { "playlistId": 501, "name": "Q4 Marketing Campaign" } ] } ``` ```APIDOC ## GET /api/Playlists/{playlistId} ### Description Retrieves a specific playlist by its ID. ### Method GET ### Endpoint /api/Playlists/{playlistId} ### Parameters #### Path Parameters - **playlistId** (integer) - Required - The ID of the playlist to retrieve. ### Request Example ### Response #### Success Response (200) - **playlistId** (integer) - The unique identifier for the playlist. - **name** (string) - The name of the playlist. #### Response Example { "playlistId": 501, "name": "Q4 Marketing Campaign" } ``` ```APIDOC ## PUT /api/Playlists/{playlistId} ### Description Updates an existing playlist. ### Method PUT ### Endpoint /api/Playlists/{playlistId} ### Parameters #### Path Parameters - **playlistId** (integer) - Required - The ID of the playlist to update. #### Request Body - **name** (string) - Required - The new name for the playlist. ### Request Example { "name": "Updated Q4 Campaign" } ### Response #### Success Response (200) - **playlistId** (integer) - The ID of the updated playlist. - **name** (string) - The updated name of the playlist. #### Response Example { "playlistId": 501, "name": "Updated Q4 Campaign" } ``` ```APIDOC ## DELETE /api/Playlists/{playlistId} ### Description Deletes a playlist by its ID. ### Method DELETE ### Endpoint /api/Playlists/{playlistId} ### Parameters #### Path Parameters - **playlistId** (integer) - Required - The ID of the playlist to delete. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of deletion. #### Response Example { "message": "Playlist with ID 501 deleted successfully." } ``` ```APIDOC ## POST /api/Playlists ### Description Creates a new playlist. ### Method POST ### Endpoint /api/Playlists ### Parameters #### Request Body - **name** (string) - Required - The name of the new playlist. ### Request Example { "name": "New Playlist Name" } ### Response #### Success Response (200) - **playlistId** (integer) - The ID of the newly created playlist. - **name** (string) - The name of the new playlist. #### Response Example { "playlistId": 502, "name": "New Playlist Name" } ``` -------------------------------- ### Groups API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing groups, including retrieval, creation, update, deletion, and user management within groups. Note: '/api/Groups' is deprecated. ```APIDOC ## GET /api/Groups ### Description This endpoint is deprecated. Use /api/Groups/WithPagination instead. ### Method GET ### Endpoint /api/Groups ### Parameters ### Request Example ### Response #### Success Response (200) #### Response Example ``` ```APIDOC ## POST /api/Groups ### Description Create a new group. ### Method POST ### Endpoint /api/Groups ### Parameters #### Request Body - **name** (string) - Required - The name of the new group. ### Request Example { "name": "New Project Team" } ### Response #### Success Response (200) - **id** (integer) - The ID of the newly created group. - **name** (string) - The name of the new group. #### Response Example { "id": 10, "name": "New Project Team" } ``` ```APIDOC ## GET /api/Groups/WithPagination ### Description Get the list of groups. ### Method GET ### Endpoint /api/Groups/WithPagination ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number for pagination. - **pageSize** (integer) - Optional - The number of items per page. ### Request Example ### Response #### Success Response (200) - **groups** (array) - A list of group objects. - **id** (integer) - The ID of the group. - **name** (string) - The name of the group. #### Response Example { "groups": [ { "id": 10, "name": "New Project Team" } ] } ``` ```APIDOC ## GET /api/Groups/{id} ### Description Get a specific group. ### Method GET ### Endpoint /api/Groups/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the group to retrieve. ### Request Example ### Response #### Success Response (200) - **id** (integer) - The ID of the group. - **name** (string) - The name of the group. #### Response Example { "id": 10, "name": "New Project Team" } ``` ```APIDOC ## PUT /api/Groups/{id} ### Description Update a specific group. ### Method PUT ### Endpoint /api/Groups/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the group to update. #### Request Body - **name** (string) - Required - The new name for the group. ### Request Example { "name": "Updated Project Team Name" } ### Response #### Success Response (200) - **id** (integer) - The ID of the updated group. - **name** (string) - The updated name of the group. #### Response Example { "id": 10, "name": "Updated Project Team Name" } ``` ```APIDOC ## DELETE /api/Groups/{id} ### Description Delete specific group. ### Method DELETE ### Endpoint /api/Groups/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the group to delete. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of deletion. #### Response Example { "message": "Group with ID 10 deleted successfully." } ``` ```APIDOC ## GET /api/Groups/{id}/users ### Description Get users of a specific group. ### Method GET ### Endpoint /api/Groups/{id}/users ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the group. ### Request Example ### Response #### Success Response (200) - **users** (array) - A list of user objects belonging to the group. - **userId** (integer) - The ID of the user. - **username** (string) - The username. #### Response Example { "users": [ { "userId": 201, "username": "alice.smith" } ] } ``` ```APIDOC ## POST /api/Groups/{id}/users ### Description Add user to group. ### Method POST ### Endpoint /api/Groups/{id}/users ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the group. #### Request Body - **userId** (integer) - Required - The ID of the user to add. ### Request Example { "userId": 201 } ### Response #### Success Response (200) - **message** (string) - Confirmation message of user addition. #### Response Example { "message": "User 201 added to group 10." } ``` ```APIDOC ## DELETE /api/Groups/{id}/users/{userId} ### Description Delete user from a group. ### Method DELETE ### Endpoint /api/Groups/{id}/users/{userId} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the group. - **userId** (integer) - Required - The ID of the user to remove. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of user removal. #### Response Example { "message": "User 201 removed from group 10." } ``` -------------------------------- ### UserCustomClaims API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing custom claims associated with users. ```APIDOC ## GET /api/UserCustomClaims/{userId} ### Description Get all user claims for a specific user. ### Method GET ### Endpoint /api/UserCustomClaims/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user whose claims are to be retrieved. ### Response #### Success Response (200) - **claims** (array) - A list of user claims. #### Response Example { "claims": [ { "code": "claim1", "value": "value1" }, { "code": "claim2", "value": "value2" } ] } ``` ```APIDOC ## POST /api/UserCustomClaims/{userId} ### Description Create a new claim for a specified user. ### Method POST ### Endpoint /api/UserCustomClaims/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user to whom the claim will be added. #### Request Body - **claim** (object) - Required - The claim object to create. - **code** (string) - Required - The code of the claim. - **value** (string) - Required - The value of the claim. ### Request Example { "claim": { "code": "newClaimCode", "value": "newClaimValue" } } ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating successful creation. #### Response Example { "message": "Claim created successfully for user." } ``` ```APIDOC ## PUT /api/UserCustomClaims/{userId} ### Description Update claims for a specified user. ### Method PUT ### Endpoint /api/UserCustomClaims/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user whose claims are to be updated. #### Request Body - **claims** (array) - Required - An array of claim objects to update. - **code** (string) - Required - The code of the claim. - **value** (string) - Required - The new value of the claim. ### Request Example { "claims": [ { "code": "claim1", "value": "updatedValue1" } ] } ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating successful update. #### Response Example { "message": "Claims updated successfully for user." } ``` ```APIDOC ## DELETE /api/UserCustomClaims/{userId}/{code} ### Description Delete an existing claim for a specified user. ### Method DELETE ### Endpoint /api/UserCustomClaims/{userId}/{code} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user from whom the claim will be deleted. - **code** (string) - Required - The code of the claim to delete. ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating successful deletion. #### Response Example { "message": "Claim deleted successfully for user." } ``` -------------------------------- ### AccessHistory API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for retrieving access history. Note: '/api/AccessHistory' is deprecated. ```APIDOC ## GET /api/AccessHistory ### Description This endpoint is deprecated. Use GetAccessHistoryByPageNumberAsync instead. Get the access history of your PowerBI Portal Front Office. ### Method GET ### Endpoint /api/AccessHistory ### Parameters ### Request Example ### Response #### Success Response (200) #### Response Example ``` ```APIDOC ## GET /api/AccessHistory/GetAccessHistoryByPageNumber ### Description Get the access history of your PowerBI Portal Front Office with Page Number. ### Method GET ### Endpoint /api/AccessHistory/GetAccessHistoryByPageNumber ### Parameters #### Query Parameters - **pageNumber** (integer) - Required - The page number for retrieving access history. ### Request Example ### Response #### Success Response (200) - **accessHistory** (array) - List of access history records. - **timestamp** (string) - The time of the access. - **user** (string) - The user who accessed the resource. - **resource** (string) - The resource that was accessed. #### Response Example { "accessHistory": [ { "timestamp": "2023-10-27T10:00:00Z", "user": "user1@example.com", "resource": "/files/document1.pdf" } ] } ``` -------------------------------- ### Areas API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing areas, including retrieval, creation, update, and deletion. ```APIDOC ## GET /api/Areas ### Description Retrieves a list of all areas. ### Method GET ### Endpoint /api/Areas ### Parameters ### Request Example ### Response #### Success Response (200) - **areas** (array) - A list of area objects. - **areaId** (integer) - The unique identifier for the area. - **name** (string) - The name of the area. #### Response Example { "areas": [ { "areaId": 1, "name": "Marketing" }, { "areaId": 2, "name": "Sales" } ] } ``` ```APIDOC ## POST /api/Areas ### Description Creates a new area. ### Method POST ### Endpoint /api/Areas ### Parameters #### Request Body - **name** (string) - Required - The name of the new area. ### Request Example { "name": "New Area Name" } ### Response #### Success Response (200) - **areaId** (integer) - The ID of the newly created area. - **name** (string) - The name of the newly created area. #### Response Example { "areaId": 3, "name": "New Area Name" } ``` ```APIDOC ## GET /api/Areas/{areaId} ### Description Retrieves a specific area by its ID. ### Method GET ### Endpoint /api/Areas/{areaId} ### Parameters #### Path Parameters - **areaId** (integer) - Required - The ID of the area to retrieve. ### Request Example ### Response #### Success Response (200) - **areaId** (integer) - The unique identifier for the area. - **name** (string) - The name of the area. #### Response Example { "areaId": 1, "name": "Marketing" } ``` ```APIDOC ## PUT /api/Areas/{areaId} ### Description Updates an existing area's data. ### Method PUT ### Endpoint /api/Areas/{areaId} ### Parameters #### Path Parameters - **areaId** (integer) - Required - The ID of the area to update. #### Request Body - **name** (string) - Required - The new name for the area. ### Request Example { "name": "Updated Area Name" } ### Response #### Success Response (200) - **areaId** (integer) - The ID of the updated area. - **name** (string) - The updated name of the area. #### Response Example { "areaId": 1, "name": "Updated Area Name" } ``` ```APIDOC ## DELETE /api/Areas/{areaId} ### Description Deletes a area by its ID. ### Method DELETE ### Endpoint /api/Areas/{areaId} ### Parameters #### Path Parameters - **areaId** (integer) - Required - The ID of the area to delete. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of deletion. #### Response Example { "message": "Area with ID 1 deleted successfully." } ``` -------------------------------- ### GroupCustomClaims API Source: https://admin.powerbiportal.com/docs/swagger/index Endpoints for managing custom claims associated with groups. ```APIDOC ## GET /api/GroupCustomClaims/{groupId} ### Description Get all group claims for a specific group. ### Method GET ### Endpoint /api/GroupCustomClaims/{groupId} ### Parameters #### Path Parameters - **groupId** (integer) - Required - The ID of the group. ### Request Example ### Response #### Success Response (200) - **claims** (array) - A list of custom claims for the group. - **code** (string) - The claim code. - **value** (string) - The claim value. #### Response Example { "claims": [ { "code": "REGION", "value": "NORTH" } ] } ``` ```APIDOC ## POST /api/GroupCustomClaims/{groupId} ### Description Create a new claim for a specified group. ### Method POST ### Endpoint /api/GroupCustomClaims/{groupId} ### Parameters #### Path Parameters - **groupId** (integer) - Required - The ID of the group. #### Request Body - **code** (string) - Required - The code for the new claim. - **value** (string) - Required - The value for the new claim. ### Request Example { "code": "DEPARTMENT", "value": "IT" } ### Response #### Success Response (200) - **message** (string) - Confirmation message of claim creation. #### Response Example { "message": "Claim DEPARTMENT=IT added to group." } ``` ```APIDOC ## PUT /api/GroupCustomClaims/{groupId} ### Description Update claims for a specified group. ### Method PUT ### Endpoint /api/GroupCustomClaims/{groupId} ### Parameters #### Path Parameters - **groupId** (integer) - Required - The ID of the group. #### Request Body - **claims** (array) - Required - An array of claim objects to update or add. - **code** (string) - Required - The claim code. - **value** (string) - Required - The new claim value. ### Request Example { "claims": [ { "code": "REGION", "value": "SOUTH" } ] } ### Response #### Success Response (200) - **message** (string) - Confirmation message of claims update. #### Response Example { "message": "Claims updated for the group." } ``` ```APIDOC ## DELETE /api/GroupCustomClaims/{groupId}/{code} ### Description Delete an existing claim for a specified group. ### Method DELETE ### Endpoint /api/GroupCustomClaims/{groupId}/{code} ### Parameters #### Path Parameters - **groupId** (integer) - Required - The ID of the group. - **code** (string) - Required - The code of the claim to delete. ### Request Example ### Response #### Success Response (200) - **message** (string) - Confirmation message of claim deletion. #### Response Example { "message": "Claim REGION deleted from group." } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.