github.com/optim-corp/cios-golang-sdk@v0.5.1/cios/docs/ResourceOwnerApi.md (about) 1 # \ResourceOwnerApi 2 3 All URIs are relative to *http://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetResourceOwner**](ResourceOwnerApi.md#GetResourceOwner) | **Get** /v2/resource_owners/{resource_owner_id} | 8 [**GetResourceOwners**](ResourceOwnerApi.md#GetResourceOwners) | **Get** /v2/resource_owners | 9 10 11 12 ## GetResourceOwner 13 14 > ResourceOwner GetResourceOwner(ctx, resourceOwnerId).Execute() 15 16 17 18 ### Example 19 20 ```go 21 package main 22 23 import ( 24 "context" 25 "fmt" 26 "os" 27 openapiclient "./openapi" 28 ) 29 30 func main() { 31 resourceOwnerId := "resourceOwnerId_example" // string | 32 33 configuration := openapiclient.NewConfiguration() 34 api_client := openapiclient.NewAPIClient(configuration) 35 resp, r, err := api_client.ResourceOwnerApi.GetResourceOwner(context.Background(), resourceOwnerId).Execute() 36 if err.Error() != "" { 37 fmt.Fprintf(os.Stderr, "Error when calling `ResourceOwnerApi.GetResourceOwner``: %v\n", err) 38 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 39 } 40 // response from `GetResourceOwner`: ResourceOwner 41 fmt.Fprintf(os.Stdout, "Response from `ResourceOwnerApi.GetResourceOwner`: %v\n", resp) 42 } 43 ``` 44 45 ### Path Parameters 46 47 48 Name | Type | Description | Notes 49 ------------- | ------------- | ------------- | ------------- 50 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 51 **resourceOwnerId** | **string** | | 52 53 ### Other Parameters 54 55 Other parameters are passed through a pointer to a apiGetResourceOwnerRequest struct via the builder pattern 56 57 58 Name | Type | Description | Notes 59 ------------- | ------------- | ------------- | ------------- 60 61 62 ### Return type 63 64 [**ResourceOwner**](ResourceOwner.md) 65 66 ### Authorization 67 68 [bearerAuth](../README.md#bearerAuth) 69 70 ### HTTP request headers 71 72 - **Content-Type**: Not defined 73 - **Accept**: application/json 74 75 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 76 [[Back to Model list]](../README.md#documentation-for-models) 77 [[Back to README]](../README.md) 78 79 80 ## GetResourceOwners 81 82 > MultipleResourceOwner GetResourceOwners(ctx).GroupId(groupId).UserId(userId).Type_(type_).Page(page).Offset(offset).Limit(limit).OrderBy(orderBy).Order(order).Execute() 83 84 85 86 ### Example 87 88 ```go 89 package main 90 91 import ( 92 "context" 93 "fmt" 94 "os" 95 openapiclient "./openapi" 96 ) 97 98 func main() { 99 groupId := "groupId_example" // string | (optional) 100 userId := TODO // string | (optional) 101 type_ := "type__example" // string | (optional) 102 page := "page_example" // string | (optional) 103 offset := int64(789) // int64 | ページネーションのうち、何件読み飛ばすか (optional) 104 limit := int64(789) // int64 | ページネーションのうち、上位何件取得するか (optional) 105 orderBy := "orderBy_example" // string | ソート対象。指定順に高優先でのソートとなる (optional) 106 order := "order_example" // string | ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 (optional) 107 108 configuration := openapiclient.NewConfiguration() 109 api_client := openapiclient.NewAPIClient(configuration) 110 resp, r, err := api_client.ResourceOwnerApi.GetResourceOwners(context.Background()).GroupId(groupId).UserId(userId).Type_(type_).Page(page).Offset(offset).Limit(limit).OrderBy(orderBy).Order(order).Execute() 111 if err.Error() != "" { 112 fmt.Fprintf(os.Stderr, "Error when calling `ResourceOwnerApi.GetResourceOwners``: %v\n", err) 113 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 114 } 115 // response from `GetResourceOwners`: MultipleResourceOwner 116 fmt.Fprintf(os.Stdout, "Response from `ResourceOwnerApi.GetResourceOwners`: %v\n", resp) 117 } 118 ``` 119 120 ### Path Parameters 121 122 123 124 ### Other Parameters 125 126 Other parameters are passed through a pointer to a apiGetResourceOwnersRequest struct via the builder pattern 127 128 129 Name | Type | Description | Notes 130 ------------- | ------------- | ------------- | ------------- 131 **groupId** | **string** | | 132 **userId** | [**string**](string.md) | | 133 **type_** | **string** | | 134 **page** | **string** | | 135 **offset** | **int64** | ページネーションのうち、何件読み飛ばすか | 136 **limit** | **int64** | ページネーションのうち、上位何件取得するか | 137 **orderBy** | **string** | ソート対象。指定順に高優先でのソートとなる | 138 **order** | **string** | ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 | 139 140 ### Return type 141 142 [**MultipleResourceOwner**](MultipleResourceOwner.md) 143 144 ### Authorization 145 146 [bearerAuth](../README.md#bearerAuth) 147 148 ### HTTP request headers 149 150 - **Content-Type**: Not defined 151 - **Accept**: application/json 152 153 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 154 [[Back to Model list]](../README.md#documentation-for-models) 155 [[Back to README]](../README.md) 156