Doc 2708 api add api s to edit fin ops user permissions for accounts and policies #736
Conversation
…-Permissions-for-Accounts-and-Policies
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| '500': | ||
| description: Internal error response. Please try again later. |
There was a problem hiding this comment.
Internal error response. Try again.
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| '403': | ||
| description: Forbidden error response. Not permitted to call this API. |
There was a problem hiding this comment.
Forbidden error response. You need permissions to call this API.
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| '500': | ||
| description: Internal error response. Please try again later. |
There was a problem hiding this comment.
Internal error response. Try again.
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| '403': | ||
| description: Forbidden error response. Not permitted to call this API. |
There was a problem hiding this comment.
Forbidden error response. You need permissions to call this API.
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| '403': | ||
| description: Forbidden error response. Not permitted to call this API. |
There was a problem hiding this comment.
Forbidden error response. You need permissions to call this API.
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| '500': | ||
| description: Internal error response. Please try again later. |
There was a problem hiding this comment.
Internal error response. Try again.
| tags: | ||
| - Organizations | ||
| summary: Update FinOps Authorization For User | ||
| description: Update the FinOps authorization configuration for user. |
There was a problem hiding this comment.
Update the FinOps authorization configuration for a user.
or
Update the FinOps authorization configuration for users.
| properties: | ||
| id: | ||
| type: string | ||
| description: "Provider account's ID.\r\nThis is the unique as defined by the service provider (e.g. AWS, Azure)." |
There was a problem hiding this comment.
Provider account ID. This is the unique ID from the service provider, such as AWS, Azure.
| nullable: true | ||
| example: Test | ||
| additionalProperties: false | ||
| description: Represents a (cloud) provider account ID. |
There was a problem hiding this comment.
A cloud provider account ID.
| nullable: true | ||
| example: Effective Cost | ||
| additionalProperties: false | ||
| description: Represents a FinOps cost type. |
| nullable: true | ||
| example: Billing Engine View All Only | ||
| additionalProperties: false | ||
| description: Represents a FinOps authorization policy. |
There was a problem hiding this comment.
A FinOps authorization policy.
| type: string | ||
| - name: paginationSize | ||
| in: query | ||
| description: number of items to include in the response |
There was a problem hiding this comment.
The number of items to include in the response.
| type: integer | ||
| - name: paginationKey | ||
| in: query | ||
| description: key used to fetch the next page of items |
There was a problem hiding this comment.
The key used to get the next page of items.
| action: | ||
| $ref: listAction.yaml | ||
| additionalProperties: false | ||
| description: Represents the information for a cost type list modification. |
There was a problem hiding this comment.
The information for a cost type list modification.
| - Add | ||
| - Remove | ||
| type: string | ||
| description: Represents an action for managing items in a list. |
There was a problem hiding this comment.
An action for managing items in a list.
| type: array | ||
| items: | ||
| $ref: costTypeRequestListModification.yaml | ||
| description: "List of cost types to add/remove.\r\nCost type apply to all accounts assigned to the user (regardless of how the user has access to the account).\r\nIf user already has an existing list of cost types, the requested actions will be applied to this existing \r\nlist unless AuthorizationService.Models.Apis.AuthConfigs.User.UserAuthConfigChanges.ResetCostTypes is true (which will clear all existing cost types first)." |
There was a problem hiding this comment.
List of cost types to add/remove.\r\nCost type applies to all accounts assigned to the user (regardless of how the user has access to the account).\r\nIf the user already has an existing list of cost types, the requested actions are applied to this existing \r\nlist unless AuthorizationService.Models.Apis.AuthConfigs.User.UserAuthConfigChanges.ResetCostTypes is true (which will clear all existing cost types first).
| nullable: true | ||
| organizationId: | ||
| type: string | ||
| description: "ID of the target Spot organization where the authorization configuration should be applied.\r\nOptional: Defaults to the caller's current Spot organization.\r\nIf specified, the ID must be one of the following:\r\n- The caller's current Spot organization\r\n- A child Spot organization of the caller's current Spot organization." |
There was a problem hiding this comment.
ID of the target Spot organization where the authorization configuration should be applied.\r\nOptional: Defaults to the caller's current Spot organization.\r\nIf specified, the ID must be one of these:\r\n- The caller's current Spot organization\r\n- A child Spot organization of the caller's current Spot organization
| description: "List of policies to add/remove.\r\nIf user or group already has an existing list of policies, the requested actions will be applied to this existing \r\nlist unless AuthorizationService.Models.Apis.CommonAuthConfigChanges`1.ResetPolicies is true (which will clear all existing policies first)." | ||
| nullable: true | ||
| additionalProperties: false | ||
| description: Represents FinOps authorization changes that apply to a user. |
There was a problem hiding this comment.
The FinOps authorization changes for a user.
| type: array | ||
| items: | ||
| $ref: authConfigPolicy.yaml | ||
| description: Auth policies assigned to this user. |
There was a problem hiding this comment.
Authorization policies assigned to this user.
| authChanges: | ||
| $ref: userAuthConfigChanges.yaml | ||
| additionalProperties: false | ||
| description: Request to update the FinOps authorization config for a specific user. |
There was a problem hiding this comment.
Request to update the FinOps authorization configuration for a specific user.
| afterChanges: | ||
| $ref: userAuthConfigResponseModel.yaml | ||
| additionalProperties: false | ||
| description: Represents the FinOps authorization configuration for a specific user (before and after changes). [kind/spotinst:cbi:authorization:user] |
There was a problem hiding this comment.
The FinOps authorization configuration for a specific user (before and after changes). [kind/spotinst:cbi:authorization:user]
| type: array | ||
| items: | ||
| $ref: costTypeRequestListModification.yaml | ||
| description: "List of cost types to add/remove.\r\nCost type apply to all accounts assigned to the user (regardless of how the user has access to the account).\r\nIf user already has an existing list of cost types, the requested actions will be applied to this existing\r\nlist unless resetCostTypes is true (which will clear all existing cost types first)." |
There was a problem hiding this comment.
List of cost types to add/remove.\r\nCost type applies to all accounts assigned to the user (regardless of how the user has access to the account).\r\nIf the user already has an existing list of cost types, the requested actions are applied to this existing \r\nlist unless AuthorizationService.Models.Apis.AuthConfigs.User.UserAuthConfigChanges.ResetCostTypes is true (which will clear all existing cost types first).
@mdcolombaninetapp
mdcolombaninetapp
deleted the
DOC-2708-API-add-API-s-to-Edit-FinOps-User-Permissions-for-Accounts-and-Policies
branch
Jira Ticket
DOC-2708
Other