github.com/optim-corp/cios-golang-sdk@v0.5.1/sdk/service/account/README.md (about)

     1  # Account API
     2  
     3  ## Me API
     4  
     5  ### Interface
     6  
     7  ```
     8  GetMe(ciosctx.RequestCtx) (cios.Me, *_nethttp.Response, error)
     9  ```
    10  ### Usage
    11  
    12  #### Get Me
    13  
    14  ```go
    15  me, httpResponse, err := client.Account().GetMe(ctx)
    16  ```
    17  
    18  
    19  ## Group API
    20  
    21  ### Interface
    22  
    23  ```
    24  GetGroups(ciosctx.RequestCtx, cios.ApiGetGroupsRequest) (cios.MultipleGroup, *_nethttp.Response, error)
    25  GetGroupsAll(ciosctx.RequestCtx, cios.ApiGetGroupsRequest) ([]cios.Group, *_nethttp.Response, error)
    26  GetGroupsUnlimited(ciosctx.RequestCtx, cios.ApiGetGroupsRequest) ([]cios.Group, *_nethttp.Response, error)
    27  GetGroup(ciosctx.RequestCtx, string, *string) (cios.Group, *_nethttp.Response, error)
    28  GetGroupByResourceOwnerId(ciosctx.RequestCtx, string, *string) (cios.Group, *_nethttp.Response, error)
    29  GetGroupMapByResourceOwner(ciosctx.RequestCtx, cios.ApiGetGroupsRequest, cios.ApiGetResourceOwnersRequest) (map[string]cios.Group, *_nethttp.Response, error)
    30  DeleteGroup(ciosctx.RequestCtx, string) (*_nethttp.Response, error)
    31  CreateGroup(ciosctx.RequestCtx, cios.GroupCreateRequest) (cios.Group, *_nethttp.Response, error)
    32  UpdateGroup(ciosctx.RequestCtx, string, cios.GroupUpdateRequest) (cios.Group, *_nethttp.Response, error)
    33  ```
    34  
    35  ### Usage
    36  
    37  
    38  #### Get a Group
    39  ```go
    40  includes := "children"
    41  group, httpResponse, err := client.Account().GetGroup(ctx, "groupID", &includes)
    42  ```
    43  
    44  #### Get Groups max limit 1000
    45  
    46  ```go
    47  options := srvaccount.MakeGetGroupsOpts
    48  groups, httpResponse, err := client.Account().GetGroups(ctx, options().Tags("sample_test").Limit(10))
    49  ```
    50  
    51  #### Get Groups no limit
    52  
    53  ```go
    54  options := srvaccount.MakeGetGroupsOpts
    55  groups, httpResponse, err := client.Account().GetGroupsAll(ctx, options().Tags("sample_test").Limit(2000))
    56  ```
    57  
    58  #### Get Groups unlimited
    59  
    60  ```go
    61  options := srvaccount.MakeGetGroupsOpts
    62  groups, httpResponse, err := client.Account().GetGroupsUnlimited(ctx, options().Tags("sample_test"))
    63  ```
    64  
    65  #### Get a Group by Resource Owner ID
    66  
    67  ```go
    68  includes := "children"
    69  group, httpResponse, err := client.Account().GetGroupByResourceOwnerId(ctx, "resource_owner_id", &includes)
    70  ```
    71  
    72  #### Crete a Group
    73  
    74  ```go
    75  group, httpResponse, err := client.Account().CreateGroup(ctx, cios.GroupCreateRequest{
    76      Name: "",
    77      Type: "",
    78  })
    79  ```
    80  
    81  #### Update a Group
    82  
    83  ```go
    84  parentGroupId := "parent_group_id"
    85  groupName := "group_name"
    86  group, httpResponse, err := client.Account().UpdateGroup(ctx, "group_id",
    87      cios.GroupUpdateRequest{
    88          ParentGroupId: &parentGroupId,
    89          Name:          &groupName,
    90      })
    91  ```
    92  
    93  #### Delete a Group
    94  
    95  ```go
    96  httpResponse, err := client.Account().DeleteGroup(ctx, "group_id")
    97  ```
    98  
    99  ## Resource Owner API
   100  
   101  
   102  ### interface
   103  
   104  ```
   105  GetResourceOwners(ciosctx.RequestCtx, cios.ApiGetResourceOwnersRequest) (cios.MultipleResourceOwner, *_nethttp.Response, error)
   106  GetResourceOwnersAll(ciosctx.RequestCtx, cios.ApiGetResourceOwnersRequest) ([]cios.ResourceOwner, *_nethttp.Response, error)
   107  GetResourceOwnersUnlimited(ciosctx.RequestCtx, cios.ApiGetResourceOwnersRequest) ([]cios.ResourceOwner, *_nethttp.Response, error)
   108  GetResourceOwner(ciosctx.RequestCtx, string) (cios.ResourceOwner, *_nethttp.Response, error)
   109  GetResourceOwnerByGroupId(ciosctx.RequestCtx, string) (cios.ResourceOwner, *_nethttp.Response, error)
   110  GetResourceOwnersMapByID(ciosctx.RequestCtx) (map[string]cios.ResourceOwner, *_nethttp.Response, error)
   111  GetResourceOwnersMapByGroupID(ciosctx.RequestCtx) (map[string]cios.ResourceOwner, error)
   112  ```
   113  
   114  ### Usage
   115  
   116  #### Get a ResourceOwner
   117  
   118  ```go
   119  resourceOwner, httpResponse, err := client.Account().GetResourceOwner(ctx, "resource_owner_id")
   120  ```
   121  
   122  #### Get a ResourceOwner by Group ID
   123  
   124  ```go
   125  resourceOwner, httpResponse, err := client.Account().GetResourceOwnerByGroupId(ctx, "group_id")
   126  ```
   127  
   128  #### Get ResourceOwner Map by ResourceOwner ID
   129  
   130  ```go
   131  resourceOwner, httpResponse, err := client.Account().GetResourceOwnersMapByID(ctx)
   132  ```
   133  
   134  #### Get ResourceOwner Map by Group ID
   135  
   136  ```go
   137  resourceOwner, httpResponse, err := client.Account().GetResourceOwnersMapByGroupID(ctx)
   138  ```
   139  
   140  #### Get ResourceOwners max limit 1000
   141  
   142  ```go
   143  options := srvaccount.MakeGetResourceOwnersOpts
   144  resourceOwners, httpResponse, err := client.Account().GetResourceOwners(ctx, options().Limit(20).Offset(1000))
   145  ```
   146  
   147  #### Get ResourceOwners no limit
   148  
   149  ```go
   150  options := srvaccount.MakeGetResourceOwnersOpts
   151  resourceOwners, httpResponse, err := client.Account().GetResourceOwnersAll(ctx, options().Limit(20000).Offset(1000))
   152  ```
   153  
   154  #### Get ResourceOwners unlimited
   155  
   156  ```go
   157  options := srvaccount.MakeGetResourceOwnersOpts
   158  resourceOwners, httpResponse, err := client.Account().GetResourceOwnersUnlimited(ctx, options().Offset(1000))
   159  ```