All URIs are relative to https://cloud.mongodb.com
| Method | HTTP request | Description |
|---|---|---|
| AddOneOrMoreTeamsToOneProject | Post /api/atlas/v1.0/groups/{groupId}/teams | Add One or More Teams to One Project |
| AssignOneOrganizationUserToOneTeam | Post /api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users | Assign MongoDB Cloud Users from One Organization to One Team |
| CreateOneTeamInOneOrganization | Post /api/atlas/v1.0/orgs/{orgId}/teams | Create One Team in One Organization |
| RemoveOneMongoDBCloudUserFromOneTeam | Delete /api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users/{userId} | Remove One MongoDB Cloud User from One Team |
| RemoveOneTeamFromOneOrganization | Delete /api/atlas/v1.0/orgs/{orgId}/teams/{teamId} | Remove One Team from One Organization |
| RemoveOneTeamFromOneProject | Delete /api/atlas/v1.0/groups/{groupId}/teams/{teamId} | Remove One Team from One Project |
| RenameOneTeam | Patch /api/atlas/v1.0/orgs/{orgId}/teams/{teamId} | Rename One Team |
| ReturnAllMongoDBCloudUsersAssignedToOneTeam | Get /api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users | Return All MongoDB Cloud Users Assigned to One Team |
| ReturnAllTeams | Get /api/atlas/v1.0/groups/{groupId}/teams | Return All Teams in One Project |
| ReturnAllTeamsInOneOrganization | Get /api/atlas/v1.0/orgs/{orgId}/teams | Return All Teams in One Organization |
| ReturnOneTeamUsingItsId | Get /api/atlas/v1.0/orgs/{orgId}/teams/{teamId} | Return One Team using its ID |
| ReturnOneTeamUsingItsName | Get /api/atlas/v1.0/orgs/{orgId}/teams/byName/{teamName} | Return One Team using its Name |
| UpdateTeamRolesInOneProject | Patch /api/atlas/v1.0/groups/{groupId}/teams/{teamId} | Update Team Roles in One Project |
PaginatedTeamRoleView AddOneOrMoreTeamsToOneProject(ctx, groupId).ApiTeamRoleView(apiTeamRoleView).Envelope(envelope).Pretty(pretty).Execute()
Add One or More Teams to One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
apiTeamRoleView := *openapiclient.NewApiTeamRoleView([]openapiclient.Link{*openapiclient.NewLink()}) // ApiTeamRoleView | Team to add to the specified project.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.AddOneOrMoreTeamsToOneProject(context.Background(), groupId).ApiTeamRoleView(apiTeamRoleView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.AddOneOrMoreTeamsToOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AddOneOrMoreTeamsToOneProject`: PaginatedTeamRoleView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.AddOneOrMoreTeamsToOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. |
Other parameters are passed through a pointer to a apiAddOneOrMoreTeamsToOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiTeamRoleView | ApiTeamRoleView | Team to add to the specified project. | envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]PaginatedAppUserView AssignOneOrganizationUserToOneTeam(ctx, orgId, teamId).ApiAddUserToTeamView(apiAddUserToTeamView).Envelope(envelope).Pretty(pretty).Execute()
Assign MongoDB Cloud Users from One Organization to One Team
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamId := "teamId_example" // string | Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.
apiAddUserToTeamView := *openapiclient.NewApiAddUserToTeamView("887821d389de9fe084df2bdf") // ApiAddUserToTeamView | One or more MongoDB Cloud users that you want to add to the specified team.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.AssignOneOrganizationUserToOneTeam(context.Background(), orgId, teamId).ApiAddUserToTeamView(apiAddUserToTeamView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.AssignOneOrganizationUserToOneTeam``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AssignOneOrganizationUserToOneTeam`: []PaginatedAppUserView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.AssignOneOrganizationUserToOneTeam`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamId | string | Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users. |
Other parameters are passed through a pointer to a apiAssignOneOrganizationUserToOneTeamRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiAddUserToTeamView | ApiAddUserToTeamView | One or more MongoDB Cloud users that you want to add to the specified team. | envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiTeamView CreateOneTeamInOneOrganization(ctx, orgId).ApiTeamView(apiTeamView).Envelope(envelope).Pretty(pretty).Execute()
Create One Team in One Organization
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
apiTeamView := *openapiclient.NewApiTeamView("e254e4ade2206f4520d4107d", []openapiclient.Link{*openapiclient.NewLink()}, "Name_example", []string{"Usernames_example"}) // ApiTeamView | Team that you want to create in the specified organization.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.CreateOneTeamInOneOrganization(context.Background(), orgId).ApiTeamView(apiTeamView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.CreateOneTeamInOneOrganization``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateOneTeamInOneOrganization`: ApiTeamView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.CreateOneTeamInOneOrganization`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
Other parameters are passed through a pointer to a apiCreateOneTeamInOneOrganizationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiTeamView | ApiTeamView | Team that you want to create in the specified organization. | envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveOneMongoDBCloudUserFromOneTeam(ctx, orgId, teamId, userId).Envelope(envelope).Pretty(pretty).Execute()
Remove One MongoDB Cloud User from One Team
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.
userId := "userId_example" // string | Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.RemoveOneMongoDBCloudUserFromOneTeam(context.Background(), orgId, teamId, userId).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RemoveOneMongoDBCloudUserFromOneTeam``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user. | |
| userId | string | Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team. |
Other parameters are passed through a pointer to a apiRemoveOneMongoDBCloudUserFromOneTeamRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveOneTeamFromOneOrganization(ctx, orgId, teamId).Envelope(envelope).Pretty(pretty).Execute()
Remove One Team from One Organization
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team that you want to delete.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.RemoveOneTeamFromOneOrganization(context.Background(), orgId, teamId).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RemoveOneTeamFromOneOrganization``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team that you want to delete. |
Other parameters are passed through a pointer to a apiRemoveOneTeamFromOneOrganizationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveOneTeamFromOneProject(ctx, groupId, teamId).Envelope(envelope).Execute()
Remove One Team from One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.RemoveOneTeamFromOneProject(context.Background(), groupId, teamId).Envelope(envelope).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RemoveOneTeamFromOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. |
Other parameters are passed through a pointer to a apiRemoveOneTeamFromOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false]
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiTeamResponseView RenameOneTeam(ctx, orgId, teamId).ApiTeamView(apiTeamView).Envelope(envelope).Pretty(pretty).Execute()
Rename One Team
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team that you want to rename.
apiTeamView := *openapiclient.NewApiTeamView("e254e4ade2206f4520d4107d", []openapiclient.Link{*openapiclient.NewLink()}, "Name_example", []string{"Usernames_example"}) // ApiTeamView | Details to update on the specified team.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.RenameOneTeam(context.Background(), orgId, teamId).ApiTeamView(apiTeamView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RenameOneTeam``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RenameOneTeam`: ApiTeamResponseView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.RenameOneTeam`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team that you want to rename. |
Other parameters are passed through a pointer to a apiRenameOneTeamRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiTeamView | ApiTeamView | Details to update on the specified team. | envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedAppUserView ReturnAllMongoDBCloudUsersAssignedToOneTeam(ctx, orgId, teamId).Envelope(envelope).ItemsPerPage(itemsPerPage).PageNum(pageNum).Pretty(pretty).Execute()
Return All MongoDB Cloud Users Assigned to One Team
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
itemsPerPage := int32(100) // int32 | Number of items that the response returns per page. (optional) (default to 100)
pageNum := int32(1) // int32 | Number of the page that displays the current set of the total objects that the response returns. (optional) (default to 1)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.ReturnAllMongoDBCloudUsersAssignedToOneTeam(context.Background(), orgId, teamId).Envelope(envelope).ItemsPerPage(itemsPerPage).PageNum(pageNum).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ReturnAllMongoDBCloudUsersAssignedToOneTeam``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnAllMongoDBCloudUsersAssignedToOneTeam`: PaginatedAppUserView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ReturnAllMongoDBCloudUsersAssignedToOneTeam`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. |
Other parameters are passed through a pointer to a apiReturnAllMongoDBCloudUsersAssignedToOneTeamRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] itemsPerPage | int32 | Number of items that the response returns per page. | [default to 100] pageNum | int32 | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedTeamRoleView ReturnAllTeams(ctx, groupId).Envelope(envelope).Pretty(pretty).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute()
Return All Teams in One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
includeCount := true // bool | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. (optional) (default to true)
itemsPerPage := int32(100) // int32 | Number of items that the response returns per page. (optional) (default to 100)
pageNum := int32(1) // int32 | Number of the page that displays the current set of the total objects that the response returns. (optional) (default to 1)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.ReturnAllTeams(context.Background(), groupId).Envelope(envelope).Pretty(pretty).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ReturnAllTeams``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnAllTeams`: PaginatedTeamRoleView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ReturnAllTeams`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. |
Other parameters are passed through a pointer to a apiReturnAllTeamsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false] includeCount | bool | Flag that indicates whether the response returns the total number of items (totalCount) in the response. | [default to true] itemsPerPage | int32 | Number of items that the response returns per page. | [default to 100] pageNum | int32 | Number of the page that displays the current set of the total objects that the response returns. | [default to 1]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedTeamView ReturnAllTeamsInOneOrganization(ctx, orgId).Envelope(envelope).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).PageNum(pageNum).Pretty(pretty).Execute()
Return All Teams in One Organization
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
itemsPerPage := int32(100) // int32 | Number of items that the response returns per page. (optional) (default to 100)
includeCount := true // bool | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. (optional) (default to true)
pageNum := int32(1) // int32 | Number of the page that displays the current set of the total objects that the response returns. (optional) (default to 1)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.ReturnAllTeamsInOneOrganization(context.Background(), orgId).Envelope(envelope).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).PageNum(pageNum).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ReturnAllTeamsInOneOrganization``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnAllTeamsInOneOrganization`: PaginatedTeamView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ReturnAllTeamsInOneOrganization`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
Other parameters are passed through a pointer to a apiReturnAllTeamsInOneOrganizationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] itemsPerPage | int32 | Number of items that the response returns per page. | [default to 100] includeCount | bool | Flag that indicates whether the response returns the total number of items (totalCount) in the response. | [default to true] pageNum | int32 | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiTeamResponseView ReturnOneTeamUsingItsId(ctx, orgId, teamId).Envelope(envelope).Pretty(pretty).Execute()
Return One Team using its ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team whose information you want to return.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.ReturnOneTeamUsingItsId(context.Background(), orgId, teamId).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ReturnOneTeamUsingItsId``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnOneTeamUsingItsId`: ApiTeamResponseView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ReturnOneTeamUsingItsId`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team whose information you want to return. |
Other parameters are passed through a pointer to a apiReturnOneTeamUsingItsIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiTeamResponseView ReturnOneTeamUsingItsName(ctx, orgId, teamName).Envelope(envelope).Pretty(pretty).Execute()
Return One Team using its Name
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
orgId := "4888442a3354817a7320eb61" // string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
teamName := "teamName_example" // string | Name of the team whose information you want to return.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.ReturnOneTeamUsingItsName(context.Background(), orgId, teamName).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ReturnOneTeamUsingItsName``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnOneTeamUsingItsName`: ApiTeamResponseView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ReturnOneTeamUsingItsName`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | |
| teamName | string | Name of the team whose information you want to return. |
Other parameters are passed through a pointer to a apiReturnOneTeamUsingItsNameRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedTeamRoleView UpdateTeamRolesInOneProject(ctx, groupId, teamId).ApiTeamRoleView(apiTeamRoleView).Envelope(envelope).Pretty(pretty).Execute()
Update Team Roles in One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
teamId := "teamId_example" // string | Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.
apiTeamRoleView := *openapiclient.NewApiTeamRoleView([]openapiclient.Link{*openapiclient.NewLink()}) // ApiTeamRoleView | The project roles assigned to the specified team.
envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TeamsApi.UpdateTeamRolesInOneProject(context.Background(), groupId, teamId).ApiTeamRoleView(apiTeamRoleView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.UpdateTeamRolesInOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateTeamRolesInOneProject`: PaginatedTeamRoleView
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.UpdateTeamRolesInOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| teamId | string | Unique 24-hexadecimal digit string that identifies the team for which you want to update roles. |
Other parameters are passed through a pointer to a apiUpdateTeamRolesInOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiTeamRoleView | ApiTeamRoleView | The project roles assigned to the specified team. | envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]