github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/group.openapi.yml (about) 1 openapi: "3.0.3" 2 info: 3 version: 1.0.0 4 title: Cios Group Openapi 5 6 paths: 7 '/v2/groups': 8 get: 9 tags: 10 - group 11 description: group.read 12 operationId: getGroups 13 parameters: 14 - $ref: "../components/parameters.yml#/components/parameters/name_query" 15 - $ref: "../components/parameters.yml#/components/parameters/parent_group_id" 16 - $ref: "../components/parameters.yml#/components/parameters/state" 17 - $ref: "../components/parameters.yml#/components/parameters/city" 18 - $ref: "../components/parameters.yml#/components/parameters/address_1" 19 - $ref: "../components/parameters.yml#/components/parameters/address_2" 20 - $ref: "../components/parameters.yml#/components/parameters/group_type" 21 - $ref: "../components/parameters.yml#/components/parameters/tags" 22 - $ref: "../components/parameters.yml#/components/parameters/label" 23 - $ref: "../components/parameters.yml#/components/parameters/domain" 24 - $ref: "../components/parameters.yml#/components/parameters/offset" 25 - $ref: "../components/parameters.yml#/components/parameters/limit" 26 - $ref: "../components/parameters.yml#/components/parameters/group_order_by" 27 - $ref: "../components/parameters.yml#/components/parameters/order" 28 - $ref: "../components/parameters.yml#/components/parameters/includes" 29 - $ref: "../components/parameters.yml#/components/parameters/page" 30 31 responses: 32 200: 33 description: 'OK' 34 content: 35 application/json: 36 schema: 37 $ref: "../components/group-component.openapi.yml#/components/schemas/MultipleGroup" 38 400: 39 $ref: "../components/responses.yml#/components/responses/invalid_request" 40 401: 41 $ref: "../components/responses.yml#/components/responses/invalid_token" 42 403: 43 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 44 500: 45 $ref: "../components/responses.yml#/components/responses/internal_server_error" 46 503: 47 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 48 security: 49 - basicAuth: [] 50 post: 51 tags: 52 - group 53 description: group.write 54 operationId: createGroup 55 requestBody: 56 required: true 57 content: 58 application/json: 59 schema: 60 $ref: "../components/group-component.openapi.yml#/components/schemas/GroupCreateRequest" 61 62 responses: 63 200: 64 description: 'OK' 65 content: 66 application/json: 67 schema: 68 $ref: "../components/group-component.openapi.yml#/components/schemas/Group" 69 400: 70 $ref: "../components/responses.yml#/components/responses/invalid_request" 71 403: 72 $ref: "../components/responses.yml#/components/responses/invalid_token" 73 500: 74 $ref: "../components/responses.yml#/components/responses/internal_server_error" 75 503: 76 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 77 security: 78 - basicAuth: [] 79 '/v2/groups/{group_id}': 80 get: 81 tags: 82 - group 83 description: group.read 84 operationId: getGroup 85 parameters: 86 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 87 - $ref: "../components/parameters.yml#/components/parameters/includes" 88 responses: 89 200: 90 description: 'OK' 91 content: 92 application/json: 93 schema: 94 $ref: "../components/group-component.openapi.yml#/components/schemas/Group" 95 400: 96 $ref: "../components/responses.yml#/components/responses/invalid_request" 97 401: 98 $ref: "../components/responses.yml#/components/responses/invalid_token" 99 403: 100 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 101 500: 102 $ref: "../components/responses.yml#/components/responses/internal_server_error" 103 503: 104 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 105 security: 106 - basicAuth: [] 107 put: 108 tags: 109 - group 110 description: group.write 111 operationId: replaceGroup 112 parameters: 113 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 114 requestBody: 115 required: true 116 content: 117 application/json: 118 schema: 119 $ref: "../components/group-component.openapi.yml#/components/schemas/GroupReplaceRequest" 120 responses: 121 200: 122 description: 'OK' 123 content: 124 application/json: 125 schema: 126 $ref: "../components/group-component.openapi.yml#/components/schemas/Group" 127 400: 128 $ref: "../components/responses.yml#/components/responses/invalid_request" 129 401: 130 $ref: "../components/responses.yml#/components/responses/invalid_token" 131 403: 132 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 133 404: 134 $ref: "../components/responses.yml#/components/responses/resource_not_found" 135 500: 136 $ref: "../components/responses.yml#/components/responses/internal_server_error" 137 503: 138 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 139 security: 140 - basicAuth: [] 141 patch: 142 tags: 143 - group 144 operationId: updateGroup 145 description: group.write 146 parameters: 147 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 148 requestBody: 149 required: true 150 content: 151 application/json: 152 schema: 153 $ref: "../components/group-component.openapi.yml#/components/schemas/GroupUpdateRequest" 154 responses: 155 200: 156 description: 'OK' 157 content: 158 application/json: 159 schema: 160 $ref: "../components/group-component.openapi.yml#/components/schemas/Group" 161 400: 162 $ref: "../components/responses.yml#/components/responses/invalid_request" 163 401: 164 $ref: "../components/responses.yml#/components/responses/invalid_token" 165 403: 166 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 167 404: 168 $ref: "../components/responses.yml#/components/responses/resource_not_found" 169 500: 170 $ref: "../components/responses.yml#/components/responses/internal_server_error" 171 503: 172 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 173 security: 174 - basicAuth: [] 175 delete: 176 tags: 177 - group 178 description: group.write 179 operationId: deleteGroup 180 parameters: 181 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 182 183 responses: 184 200: 185 description: 'OK' 186 400: 187 $ref: "../components/responses.yml#/components/responses/invalid_request" 188 401: 189 $ref: "../components/responses.yml#/components/responses/invalid_token" 190 403: 191 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 192 500: 193 $ref: "../components/responses.yml#/components/responses/internal_server_error" 194 503: 195 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 196 security: 197 - basicAuth: [] 198 '/v2/groups/{group_id}/invites': 199 post: 200 tags: 201 - group 202 description: group.write 203 operationId: inviteGroup 204 parameters: 205 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 206 requestBody: 207 required: true 208 content: 209 application/json: 210 schema: 211 $ref: "../components/group-component.openapi.yml#/components/schemas/GroupInviteRequest" 212 responses: 213 200: 214 description: 'OK' 215 content: 216 application/json: 217 schema: 218 $ref: "../components/group-component.openapi.yml#/components/schemas/Member" 219 400: 220 $ref: "../components/responses.yml#/components/responses/invalid_request" 221 401: 222 $ref: "../components/responses.yml#/components/responses/invalid_token" 223 403: 224 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 225 404: 226 $ref: "../components/responses.yml#/components/responses/resource_not_found" 227 500: 228 $ref: "../components/responses.yml#/components/responses/internal_server_error" 229 503: 230 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 231 security: 232 - basicAuth: [] 233 '/v2/groups/{group_id}/members': 234 get: 235 tags: 236 - group 237 operationId: getMembers 238 parameters: 239 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 240 - $ref: "../components/parameters.yml#/components/parameters/user_id" 241 - $ref: "../components/parameters.yml#/components/parameters/name_query" 242 - $ref: "../components/parameters.yml#/components/parameters/email" 243 - $ref: "../components/parameters.yml#/components/parameters/primary" 244 - $ref: "../components/parameters.yml#/components/parameters/phonetic_family_name" 245 - $ref: "../components/parameters.yml#/components/parameters/phonetic_given_name" 246 - $ref: "../components/parameters.yml#/components/parameters/role" 247 - $ref: "../components/parameters.yml#/components/parameters/category" 248 - $ref: "../components/parameters.yml#/components/parameters/tag" 249 - $ref: "../components/parameters.yml#/components/parameters/includes" 250 - $ref: "../components/parameters.yml#/components/parameters/page" 251 - $ref: "../components/parameters.yml#/components/parameters/offset" 252 - $ref: "../components/parameters.yml#/components/parameters/limit" 253 - $ref: "../components/parameters.yml#/components/parameters/member_order_by" 254 - $ref: "../components/parameters.yml#/components/parameters/order" 255 responses: 256 200: 257 description: 'OK' 258 content: 259 application/json: 260 schema: 261 $ref: "../components/group-component.openapi.yml#/components/schemas/MultipleMemberInfo" 262 400: 263 $ref: "../components/responses.yml#/components/responses/invalid_request" 264 401: 265 $ref: "../components/responses.yml#/components/responses/invalid_token" 266 403: 267 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 268 500: 269 $ref: "../components/responses.yml#/components/responses/internal_server_error" 270 503: 271 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 272 security: 273 - basicAuth: [] 274 delete: 275 tags: 276 - group 277 operationId: deleteMember 278 parameters: 279 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 280 requestBody: 281 required: true 282 content: 283 application/json: 284 schema: 285 $ref: "../components/group-component.openapi.yml#/components/schemas/Members" 286 287 responses: 288 200: 289 description: 'OK' 290 400: 291 $ref: "../components/responses.yml#/components/responses/invalid_request" 292 401: 293 $ref: "../components/responses.yml#/components/responses/invalid_token" 294 403: 295 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 296 404: 297 $ref: "../components/responses.yml#/components/responses/resource_not_found" 298 500: 299 $ref: "../components/responses.yml#/components/responses/internal_server_error" 300 503: 301 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 302 security: 303 - basicAuth: [] 304 put: 305 tags: 306 - group 307 description: group.write 308 operationId: updateMember 309 parameters: 310 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 311 requestBody: 312 required: true 313 content: 314 application/json: 315 schema: 316 $ref: "../components/group-component.openapi.yml#/components/schemas/MultipleMember" 317 responses: 318 200: 319 description: 'OK' 320 content: 321 application/json: 322 schema: 323 $ref: "../components/group-component.openapi.yml#/components/schemas/MultipleMember" 324 400: 325 $ref: "../components/responses.yml#/components/responses/invalid_request" 326 401: 327 $ref: "../components/responses.yml#/components/responses/invalid_token" 328 403: 329 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 330 404: 331 $ref: "../components/responses.yml#/components/responses/resource_not_found" 332 500: 333 $ref: "../components/responses.yml#/components/responses/internal_server_error" 334 503: 335 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 336 security: 337 - basicAuth: [] 338 patch: 339 tags: 340 - group 341 description: group.write 342 operationId: setMember 343 parameters: 344 - $ref: "../components/parameters.yml#/components/parameters/group_id_required" 345 requestBody: 346 required: true 347 content: 348 application/json: 349 schema: 350 $ref: "../components/group-component.openapi.yml#/components/schemas/Member" 351 352 responses: 353 200: 354 description: 'OK' 355 content: 356 application/json: 357 schema: 358 $ref: "../components/group-component.openapi.yml#/components/schemas/Member" 359 400: 360 $ref: "../components/responses.yml#/components/responses/invalid_request" 361 401: 362 $ref: "../components/responses.yml#/components/responses/invalid_token" 363 403: 364 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 365 404: 366 $ref: "../components/responses.yml#/components/responses/resource_not_found" 367 500: 368 $ref: "../components/responses.yml#/components/responses/internal_server_error" 369 503: 370 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 371 security: 372 - basicAuth: [] 373 374 components: 375 securitySchemes: 376 bearerAuth: 377 type: http 378 scheme: bearer 379 bearerFormat: JWT