Skip to content

Latest commit

 

History

History
411 lines (262 loc) · 10.9 KB

RoleApi.md

File metadata and controls

411 lines (262 loc) · 10.9 KB
Raw

\RoleApi

All URIs are relative to http://localhost

Method HTTP request Description
ApiIdentityRolesAllGet Get /api/identity/roles/all
ApiIdentityRolesGet Get /api/identity/roles
ApiIdentityRolesIdDelete Delete /api/identity/roles/{id}
ApiIdentityRolesIdGet Get /api/identity/roles/{id}
ApiIdentityRolesIdPut Put /api/identity/roles/{id}
ApiIdentityRolesPost Post /api/identity/roles

ApiIdentityRolesAllGet

IdentityRoleDtoListResultDto ApiIdentityRolesAllGet(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/puupee/puupee-api-go"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

IdentityRoleDtoListResultDto

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

ApiIdentityRolesGet

IdentityRoleDtoPagedResultDto ApiIdentityRolesGet(ctx).Filter(filter).Sorting(sorting).SkipCount(skipCount).MaxResultCount(maxResultCount).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/puupee/puupee-api-go"
)

func main() {
    filter := "filter_example" // string |  (optional)
    sorting := "sorting_example" // string |  (optional)
    skipCount := int32(56) // int32 |  (optional)
    maxResultCount := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RoleApi.ApiIdentityRolesGet(context.Background()).Filter(filter).Sorting(sorting).SkipCount(skipCount).MaxResultCount(maxResultCount).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleApi.ApiIdentityRolesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ApiIdentityRolesGet`: IdentityRoleDtoPagedResultDto
    fmt.Fprintf(os.Stdout, "Response from `RoleApi.ApiIdentityRolesGet`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
filter string
sorting string
skipCount int32
maxResultCount int32

Return type

IdentityRoleDtoPagedResultDto

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

ApiIdentityRolesIdDelete

ApiIdentityRolesIdDelete(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/puupee/puupee-api-go"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleApi.ApiIdentityRolesIdDelete(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleApi.ApiIdentityRolesIdDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

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 apiApiIdentityRolesIdDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

ApiIdentityRolesIdGet

IdentityRoleDto ApiIdentityRolesIdGet(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/puupee/puupee-api-go"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RoleApi.ApiIdentityRolesIdGet(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleApi.ApiIdentityRolesIdGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ApiIdentityRolesIdGet`: IdentityRoleDto
    fmt.Fprintf(os.Stdout, "Response from `RoleApi.ApiIdentityRolesIdGet`: %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 apiApiIdentityRolesIdGetRequest struct via the builder pattern

Name Type Description Notes

Return type

IdentityRoleDto

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

ApiIdentityRolesIdPut

IdentityRoleDto ApiIdentityRolesIdPut(ctx, id).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/puupee/puupee-api-go"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    body := *openapiclient.NewIdentityRoleUpdateDto("Name_example") // IdentityRoleUpdateDto |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RoleApi.ApiIdentityRolesIdPut(context.Background(), id).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleApi.ApiIdentityRolesIdPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ApiIdentityRolesIdPut`: IdentityRoleDto
    fmt.Fprintf(os.Stdout, "Response from `RoleApi.ApiIdentityRolesIdPut`: %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 apiApiIdentityRolesIdPutRequest struct via the builder pattern

Name Type Description Notes

body | IdentityRoleUpdateDto | |

Return type

IdentityRoleDto

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

ApiIdentityRolesPost

IdentityRoleDto ApiIdentityRolesPost(ctx).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/puupee/puupee-api-go"
)

func main() {
    body := *openapiclient.NewIdentityRoleCreateDto("Name_example") // IdentityRoleCreateDto |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
body IdentityRoleCreateDto

Return type

IdentityRoleDto

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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