All URIs are relative to https://app.harness.io/gateway
| Method | HTTP request | Description |
|---|---|---|
| CreateServiceAccount | Post /ng/api/serviceaccount | Creates a Service Account |
| DeleteServiceAccount | Delete /ng/api/serviceaccount/{identifier} | Deletes Service Account by ID |
| GetAggregatedServiceAccount | Get /ng/api/serviceaccount/aggregate/{identifier} | Get the Service Account by accountIdentifier and Service Account ID and Scope. |
| ListAggregatedServiceAccounts | Get /ng/api/serviceaccount/aggregate | Fetches the list of Aggregated Service Accounts corresponding to the request's filter criteria. |
| ListServiceAccount | Get /ng/api/serviceaccount | Fetches the list of Service Accounts corresponding to the request's filter criteria. |
| UpdateServiceAccount | Put /ng/api/serviceaccount/{identifier} | Updates the Service Account. |
ResponseDtoServiceAccountDto CreateServiceAccount(ctx, body, accountIdentifier, optional) Creates a Service Account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ServiceAccountDto | Details required to create Service Account | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ServiceAccountApiCreateServiceAccountOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ServiceAccountApiCreateServiceAccountOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.| Organization Identifier for the Entity | projectIdentifier | optional.| Project Identifier for the Entity |
- Content-Type: application/json, application/yaml, text/plain
- Accept: application/json, application/yaml, text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoBoolean DeleteServiceAccount(ctx, accountIdentifier, identifier, optional) Deletes Service Account by ID
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountIdentifier | string | Account Identifier for the Entity | |
| identifier | string | Service Account ID | |
| optional | *ServiceAccountApiDeleteServiceAccountOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ServiceAccountApiDeleteServiceAccountOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |
- Content-Type: Not defined
- Accept: application/json, application/yaml, text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoServiceAccountAggregateDto GetAggregatedServiceAccount(ctx, accountIdentifier, identifier, optional) Get the Service Account by accountIdentifier and Service Account ID and Scope.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountIdentifier | string | Account Identifier for the Entity | |
| identifier | string | Service Account IDr | |
| optional | *ServiceAccountApiGetAggregatedServiceAccountOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ServiceAccountApiGetAggregatedServiceAccountOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |
ResponseDtoServiceAccountAggregateDto
- Content-Type: Not defined
- Accept: application/json, application/yaml, text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoPageResponseServiceAccountAggregateDto ListAggregatedServiceAccounts(ctx, accountIdentifier, optional) Fetches the list of Aggregated Service Accounts corresponding to the request's filter criteria.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ServiceAccountApiListAggregatedServiceAccountsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ServiceAccountApiListAggregatedServiceAccountsOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity | identifiers | optional.Interface of []string| This is the list of Service Account IDs. Details specific to these IDs would be fetched. | pageIndex | optional.Int32| Indicates the number of pages. Results for these pages will be retrieved. | [default to 0] pageSize | optional.Int32| The number of the elements to fetch | [default to 50] sortOrders | optional.Interface of []SortOrder| Sort criteria for the elements. | searchTerm | optional.String| This would be used to filter Service Accounts. Any Service Account having the specified string in its Name, ID and Tag would be filtered. |
ResponseDtoPageResponseServiceAccountAggregateDto
- Content-Type: Not defined
- Accept: application/json, application/yaml, text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoListServiceAccountDto ListServiceAccount(ctx, accountIdentifier, optional) Fetches the list of Service Accounts corresponding to the request's filter criteria.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountIdentifier | string | Account Identifier for the Entity | |
| optional | *ServiceAccountApiListServiceAccountOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ServiceAccountApiListServiceAccountOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity | identifiers | optional.Interface of []string| This is the list of Service Account IDs. Details specific to these IDs would be fetched. |
ResponseDtoListServiceAccountDto
- Content-Type: Not defined
- Accept: application/json, application/yaml, text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDtoServiceAccountDto UpdateServiceAccount(ctx, body, accountIdentifier, identifier, optional) Updates the Service Account.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ServiceAccountDto | Details of the updated Service Account | |
| accountIdentifier | string | Account Identifier for the Entity | |
| identifier | string | Service Account ID | |
| optional | *ServiceAccountApiUpdateServiceAccountOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ServiceAccountApiUpdateServiceAccountOpts struct
| Name | Type | Description | Notes |
|---|
orgIdentifier | optional.| Organization Identifier for the Entity | projectIdentifier | optional.| Project Identifier for the Entity |
- Content-Type: application/json, application/yaml, text/plain
- Accept: application/json, application/yaml, text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]