Skip to content

UserGroupsResourceApi.md

Latest commit

 

History

History
402 lines (255 loc) · 10.2 KB

UserGroupsResourceApi.md

File metadata and controls

402 lines (255 loc) · 10.2 KB

\UserGroupsResourceApi

All URIs are relative to http://localhost:9080

Method HTTP request Description
ApisUserV1GroupsGet Get /apis/user/v1/groups
ApisUserV1GroupsNameGet Get /apis/user/v1/groups/{name}
ApisUserV1GroupsNamePut Put /apis/user/v1/groups/{name}
ApisUserV1GroupsPost Post /apis/user/v1/groups
ApisUserV1UsersGet Get /apis/user/v1/users
ApisUserV1UsersNameGet Get /apis/user/v1/users/{name}

ApisUserV1GroupsGet

GroupList ApisUserV1GroupsGet(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shnplr/kssapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GroupList

Authorization

SecurityScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ApisUserV1GroupsNameGet

Group ApisUserV1GroupsNameGet(ctx, name).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shnplr/kssapi"
)

func main() {
    name := "name_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

Group

Authorization

SecurityScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ApisUserV1GroupsNamePut

Group ApisUserV1GroupsNamePut(ctx, name).Group(group).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shnplr/kssapi"
)

func main() {
    name := "name_example" // string | 
    group := *openapiclient.NewGroup() // Group |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

group | Group | |

Return type

Group

Authorization

SecurityScheme

HTTP request headers

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

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

ApisUserV1GroupsPost

Group ApisUserV1GroupsPost(ctx).Group(group).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shnplr/kssapi"
)

func main() {
    group := *openapiclient.NewGroup() // Group |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
group Group

Return type

Group

Authorization

SecurityScheme

HTTP request headers

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

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

ApisUserV1UsersGet

UserList ApisUserV1UsersGet(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shnplr/kssapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

UserList

Authorization

SecurityScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ApisUserV1UsersNameGet

User ApisUserV1UsersNameGet(ctx, name).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shnplr/kssapi"
)

func main() {
    name := "name_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

User

Authorization

SecurityScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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