\TeamAPI

All URIs are relative to https://virtserver.swaggerhub.com/perimeter81/public-api-yaml/1.0.0

Method	HTTP request	Description
AddGroupMember	Post /v3/groups/{groupId}/member/{userId}	Add member to group
CreateGroup	Post /v3/groups	Create new group
CreateUser	Post /v3/users	Create new user
DeleteGroup	Delete /v3/groups/{id}	Delete group by ID
DeleteUser	Delete /v3/users/{id}	Delete user
ListGroups	Get /v3/groups	Returns paginated list of groups
ListUsers	Get /v3/users	Returns paginated list of users
RemoveGroupMember	Delete /v3/groups/{groupId}/member/{userId}	Remove member from group

AddGroupMember

Group AddGroupMember(ctx, groupId, userId).Execute()

Add member to group

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	groupId := "groupId_example" // string | 
	userId := "userId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.AddGroupMember(context.Background(), groupId, userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.AddGroupMember``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddGroupMember`: Group
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.AddGroupMember`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId	string
userId	string

Other Parameters

Other parameters are passed through a pointer to a apiAddGroupMemberRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Group

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateGroup

Group CreateGroup(ctx).CreateGroupDto(createGroupDto).Execute()

Create new group

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	createGroupDto := *openapiclient.NewCreateGroupDto("Name_example") // CreateGroupDto | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.CreateGroup(context.Background()).CreateGroupDto(createGroupDto).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.CreateGroup``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateGroup`: Group
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.CreateGroup`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateGroupRequest struct via the builder pattern

Name	Type	Description	Notes
createGroupDto	CreateGroupDto

Return type

Group

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUser

User CreateUser(ctx).CreateUserDto(createUserDto).Execute()

Create new user

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	createUserDto := *openapiclient.NewCreateUserDto("Email_example", "InviteMessage_example") // CreateUserDto | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.CreateUser(context.Background()).CreateUserDto(createUserDto).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.CreateUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateUser`: User
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.CreateUser`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateUserRequest struct via the builder pattern

Name	Type	Description	Notes
createUserDto	CreateUserDto

Return type

User

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteGroup

Group DeleteGroup(ctx, id).Execute()

Delete group by ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.DeleteGroup(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.DeleteGroup``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteGroup`: Group
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.DeleteGroup`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteGroupRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Group

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUser

User DeleteUser(ctx, id).Execute()

Delete user

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.DeleteUser(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.DeleteUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteUser`: User
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.DeleteUser`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteUserRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

User

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListGroups

GroupList ListGroups(ctx).Page(page).Limit(limit).Sort(sort).Execute()

Returns paginated list of groups

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	page := int32(56) // int32 | Page number (optional) (default to 1)
	limit := int32(56) // int32 | Number of records per page (optional) (default to 500)
	sort := "sort_example" // string | Sort order (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.ListGroups(context.Background()).Page(page).Limit(limit).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.ListGroups``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListGroups`: GroupList
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.ListGroups`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListGroupsRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Page number	[default to 1]
limit	int32	Number of records per page	[default to 500]
sort	string	Sort order

Return type

GroupList

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUsers

UserList ListUsers(ctx).Where(where).Page(page).Limit(limit).Sort(sort).Execute()

Returns paginated list of users

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	where := "where_example" // string | Query filter for users (optional)
	page := int32(56) // int32 | Page number (optional) (default to 1)
	limit := int32(56) // int32 | Number of records per page (optional) (default to 500)
	sort := map[string]string{"key": map[string]string{"key": "Inner_example"}} // map[string]string | Sort order using bracket notation, e.g. sort[email]=asc (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.ListUsers(context.Background()).Where(where).Page(page).Limit(limit).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.ListUsers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListUsers`: UserList
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.ListUsers`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListUsersRequest struct via the builder pattern

Name	Type	Description	Notes
where	string	Query filter for users
page	int32	Page number	[default to 1]
limit	int32	Number of records per page	[default to 500]
sort	map[string]map[string]string	Sort order using bracket notation, e.g. sort[email]=asc

Return type

UserList

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveGroupMember

Group RemoveGroupMember(ctx, groupId, userId).Execute()

Remove member from group

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	groupId := "groupId_example" // string | 
	userId := "userId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamAPI.RemoveGroupMember(context.Background(), groupId, userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamAPI.RemoveGroupMember``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RemoveGroupMember`: Group
	fmt.Fprintf(os.Stdout, "Response from `TeamAPI.RemoveGroupMember`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId	string
userId	string

Other Parameters

Other parameters are passed through a pointer to a apiRemoveGroupMemberRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Group

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

TeamAPI.md

Latest commit

History

TeamAPI.md

File metadata and controls

\TeamAPI

AddGroupMember

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateGroup

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteGroup

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListGroups

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListUsers

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveGroupMember

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers