github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_users.json (about)

     1  {
     2    "openapi":"3.0.0",
     3    "info":{
     4      "description":"",
     5      "version":"1.0",
     6      "title":"Engage Digital API",
     7      "termsOfService":"https://developer.ringcentral.com"
     8    },
     9    "tags":[
    10      {
    11        "name":"Users"
    12      }
    13    ],
    14    "paths":{
    15      "/users":{
    16        "get":{
    17          "tags":[
    18            "Users"
    19          ],
    20          "summary":"Getting all users",
    21          "operationId":"getAllUsers",
    22          "description":"This method renders users ordered by creation date (descending).\n\nAuthorization​: only users that can view users. If the user affiliated to the token has the manage_users_of_my_teams permission, only the users belonging to at least one of the teams he’s the leader of will be returned.",
    23          "parameters":[
    24            {
    25              "name":"email",
    26              "description":"To filter users on given email.",
    27              "in":"query",
    28              "required":false,
    29              "schema":{
    30                "type":"string"
    31              }
    32            },
    33            {
    34              "name":"category_id",
    35              "description":"To filter users on given category id.",
    36              "in":"query",
    37              "required":false,
    38              "schema":{
    39                "type":"string"
    40              }
    41            },
    42            {
    43              "name":"identity_id",
    44              "description":"To filter users on given identity id.",
    45              "in":"query",
    46              "required":false,
    47              "schema":{
    48                "type":"string"
    49              }
    50            },
    51            {
    52              "name":"external_id",
    53              "description":"To filter users on given external id.",
    54              "in":"query",
    55              "required":false,
    56              "schema":{
    57                "type":"string"
    58              }
    59            },
    60            {
    61              "name":"role_id",
    62              "description":"To filter users on given role id.",
    63              "in":"query",
    64              "required":false,
    65              "schema":{
    66                "type":"string"
    67              }
    68            },
    69            {
    70              "name":"team_id",
    71              "description":"To filter users on given team id.",
    72              "in":"query",
    73              "required":false,
    74              "schema":{
    75                "type":"string"
    76              }
    77            },
    78            {
    79              "name":"offset",
    80              "in":"query",
    81              "description":"The record index to start. Default value is 0.",
    82              "required":false,
    83              "schema":{
    84                "type":"integer",
    85                "format":"int32"
    86              }
    87            },
    88            {
    89              "name":"limit",
    90              "in":"query",
    91              "description":"The max number of records to return. Default value is 30, max value is 150.",
    92              "required":false,
    93              "schema":{
    94                "type":"integer",
    95                "format":"int32"
    96              }
    97            }
    98          ],
    99          "responses":{
   100            "200":{
   101              "description":"Success",
   102              "content":{
   103                "application/json":{
   104                  "schema":{
   105                    "$ref":"#/components/schemas/GetAllUsersResponse"
   106                  }
   107                }
   108              }
   109            }
   110          }
   111        },
   112        "post":{
   113          "tags":[
   114            "Users"
   115          ],
   116          "summary":"Creating a user",
   117          "operationId":"createUser",
   118          "description":"This method creates a new user. In case of success it renders the created user, otherwise, it renders an error (422 HTTP code).",
   119          "parameters":[
   120            {
   121              "name":"category_ids[]",
   122              "in":"query",
   123              "required":false,
   124              "description":"User list of category ids (multiple).",
   125              "schema":{
   126                "type":"array",
   127                "items":{
   128                  "type":"string"
   129                }
   130              }
   131            },
   132            {
   133              "name":"email",
   134              "in":"query",
   135              "required":true,
   136              "description":"User email (mandatory).",
   137              "schema":{
   138                "type":"string"
   139              }
   140            },
   141            {
   142              "name":"enabled",
   143              "in":"query",
   144              "required":false,
   145              "description":"Whether the user is enabled or not (boolean).",
   146              "schema":{
   147                "type":"boolean"
   148              }
   149            },
   150            {
   151              "name":"external_id",
   152              "in":"query",
   153              "required":false,
   154              "description":"User external id, used for SSO.",
   155              "schema":{
   156                "type":"string"
   157              }
   158            },
   159            {
   160              "name":"firstname",
   161              "in":"query",
   162              "required":true,
   163              "description":"User firstname (mandatory).",
   164              "schema":{
   165                "type":"string"
   166              }
   167            },
   168            {
   169              "name":"gender",
   170              "in":"query",
   171              "required":false,
   172              "description":"User gender (\"man\" or \"woman\").",
   173              "schema":{
   174                "type":"string",
   175                "enum":[
   176                  "man",
   177                  "woman"
   178                ]
   179              }
   180            },
   181            {
   182              "name":"identity_ids[]",
   183              "in":"query",
   184              "required":false,
   185              "description":"User list of identity ids (multiple).",
   186              "schema":{
   187                "type":"array",
   188                "items":{
   189                  "type":"string"
   190                }
   191              }
   192            },
   193            {
   194              "name":"lastname",
   195              "in":"query",
   196              "required":true,
   197              "description":"User lastname (mandatory).",
   198              "schema":{
   199                "type":"string"
   200              }
   201            },
   202            {
   203              "name":"locale",
   204              "in":"query",
   205              "required":false,
   206              "description":"Language for the user interface.",
   207              "schema":{
   208                "type":"string"
   209              }
   210            },
   211            {
   212              "name":"nickname",
   213              "in":"query",
   214              "required":false,
   215              "description":"User nickname.",
   216              "schema":{
   217                "type":"string"
   218              }
   219            },
   220            {
   221              "name":"password",
   222              "in":"query",
   223              "required":true,
   224              "description":"User plain password (mandatory).",
   225              "schema":{
   226                "type":"string"
   227              }
   228            },
   229            {
   230              "name":"role_id",
   231              "in":"query",
   232              "required":true,
   233              "description":"User role id (mandatory).",
   234              "schema":{
   235                "type":"string"
   236              }
   237            },
   238            {
   239              "name":"team_ids[]",
   240              "in":"query",
   241              "required":false,
   242              "description":"User list of team ids (multiple).",
   243              "schema":{
   244                "type":"array",
   245                "items":{
   246                  "type":"string"
   247                }
   248              }
   249            },
   250            {
   251              "name":"timezone",
   252              "in":"query",
   253              "required":false,
   254              "description":"Use the timezone endpoint to get the timezone name (String), default is empty for domain timezone.",
   255              "schema":{
   256                "type":"string"
   257              }
   258            },
   259            {
   260              "name":"spoken_languages[]",
   261              "in":"query",
   262              "required":false,
   263              "description":"List of locales corresponding to the languages spoken by the user (multiple).",
   264              "schema":{
   265                "type":"array",
   266                "items":{
   267                  "type":"string"
   268                }
   269              }
   270            }
   271          ],
   272          "responses":{
   273            "200":{
   274              "description":"Success",
   275              "content":{
   276                "application/json":{
   277                  "schema":{
   278                    "$ref":"#/components/schemas/User"
   279                  }
   280                }
   281              }
   282            }
   283          }
   284        }
   285      },
   286      "/users/{userId}":{
   287        "get":{
   288          "tags":[
   289            "Users"
   290          ],
   291          "summary":"Getting a user from its id",
   292          "operationId":"getUser",
   293          "description":"This method renders a user from given id.",
   294          "parameters":[
   295            {
   296              "name":"userId",
   297              "in":"path",
   298              "required":true,
   299              "schema":{
   300                "type":"string"
   301              }
   302            }
   303          ],
   304          "responses":{
   305            "200":{
   306              "description":"Success",
   307              "content":{
   308                "application/json":{
   309                  "schema":{
   310                    "$ref":"#/components/schemas/User"
   311                  }
   312                }
   313              }
   314            }
   315          }
   316        },
   317        "put":{
   318          "tags":[
   319            "Users"
   320          ],
   321          "summary":"Updating a user",
   322          "operationId":"updateUser",
   323          "description":"This method updates users from given attributes and renders it in case of success.\n\nAuthorization​: only users that can update users. If the user affiliated to the token has the `manage_users_of_my_teams` permission, the updated user will need to belong to at least one of the teams he’s the leader of. The teams the user affiliated to the token is the leader of will be the only ones which can be added or removed.",
   324          "parameters":[
   325            {
   326              "name":"userId",
   327              "in":"path",
   328              "required":true,
   329              "schema":{
   330                "type":"string"
   331              }
   332            },
   333            {
   334              "name":"category_ids[]",
   335              "in":"query",
   336              "required":false,
   337              "description":"User list of category ids (multiple).",
   338              "schema":{
   339                "type":"array",
   340                "items":{
   341                  "type":"string"
   342                }
   343              }
   344            },
   345            {
   346              "name":"email",
   347              "in":"query",
   348              "required":false,
   349              "description":"User email.",
   350              "schema":{
   351                "type":"string"
   352              }
   353            },
   354            {
   355              "name":"enabled",
   356              "in":"query",
   357              "required":false,
   358              "description":"Whether the user is enabled or not (boolean).",
   359              "schema":{
   360                "type":"boolean"
   361              }
   362            },
   363            {
   364              "name":"external_id",
   365              "in":"query",
   366              "required":false,
   367              "description":"User external id, used for SSO.",
   368              "schema":{
   369                "type":"string"
   370              }
   371            },
   372            {
   373              "name":"firstname",
   374              "in":"query",
   375              "required":false,
   376              "description":"User firstname.",
   377              "schema":{
   378                "type":"string"
   379              }
   380            },
   381            {
   382              "name":"gender",
   383              "in":"query",
   384              "required":false,
   385              "description":"User gender (\"man\" or \"woman\").",
   386              "schema":{
   387                "type":"string",
   388                "enum":[
   389                  "man",
   390                  "woman"
   391                ]
   392              }
   393            },
   394            {
   395              "name":"identity_ids[]",
   396              "in":"query",
   397              "required":false,
   398              "description":"User list of identity ids (multiple).",
   399              "schema":{
   400                "type":"array",
   401                "items":{
   402                  "type":"string"
   403                }
   404              }
   405            },
   406            {
   407              "name":"lastname",
   408              "in":"query",
   409              "required":false,
   410              "description":"User lastname.",
   411              "schema":{
   412                "type":"string"
   413              }
   414            },
   415            {
   416              "name":"locale",
   417              "in":"query",
   418              "required":false,
   419              "description":"Language for the user interface.",
   420              "schema":{
   421                "type":"string"
   422              }
   423            },
   424            {
   425              "name":"nickname",
   426              "in":"query",
   427              "required":false,
   428              "description":"User nickname.",
   429              "schema":{
   430                "type":"string"
   431              }
   432            },
   433            {
   434              "name":"password",
   435              "in":"query",
   436              "required":false,
   437              "description":"User plain password.",
   438              "schema":{
   439                "type":"string"
   440              }
   441            },
   442            {
   443              "name":"role_id",
   444              "in":"query",
   445              "required":false,
   446              "description":"User role id.",
   447              "schema":{
   448                "type":"string"
   449              }
   450            },
   451            {
   452              "name":"team_ids[]",
   453              "in":"query",
   454              "required":false,
   455              "description":"User list of team ids (multiple).",
   456              "schema":{
   457                "type":"array",
   458                "items":{
   459                  "type":"string"
   460                }
   461              }
   462            },
   463            {
   464              "name":"timezone",
   465              "in":"query",
   466              "required":false,
   467              "description":"Use the timezone endpoint to get the timezone name (String), default is empty for domain timezone.",
   468              "schema":{
   469                "type":"string"
   470              }
   471            },
   472            {
   473              "name":"spoken_languages[]",
   474              "in":"query",
   475              "required":false,
   476              "description":"List of locales corresponding to the languages spoken by the user (multiple).",
   477              "schema":{
   478                "type":"array",
   479                "items":{
   480                  "type":"string"
   481                }
   482              }
   483            }
   484          ],
   485          "responses":{
   486            "200":{
   487              "description":"Success",
   488              "content":{
   489                "application/json":{
   490                  "schema":{
   491                    "$ref":"#/components/schemas/User"
   492                  }
   493                }
   494              }
   495            }
   496          }
   497        },
   498        "delete":{
   499          "tags":[
   500            "Users"
   501          ],
   502          "summary":"Deleting a user",
   503          "operationId":"deleteUser",
   504          "description":"This method deletes the given user. In case of success it renders the deleted user, otherwise, it renders an error (422 HTTP code).\n\nAuthorization​: only users that can update users. The user affiliated to the token must have at least all the permissions of the other user. If the user affiliated to the token has the manage_users_of_my_teams permission, the deleted user will need to belong to at least one of the teams he’s the leader of.",
   505          "parameters":[
   506            {
   507              "name":"userId",
   508              "in":"path",
   509              "required":true,
   510              "schema":{
   511                "type":"string"
   512              }
   513            }
   514          ],
   515          "responses":{
   516            "200":{
   517              "description":"Success",
   518              "content":{
   519                "application/json":{
   520                  "schema":{
   521                    "$ref":"#/components/schemas/User"
   522                  }
   523                }
   524              }
   525            }
   526          }
   527        }
   528      },
   529      "/users/invite":{
   530        "post":{
   531          "tags":[
   532            "Users"
   533          ],
   534          "summary":"Inviting a user",
   535          "operationId":"inviteUser",
   536          "description":"This method invites a new user. In case of success it renders the created user, otherwise, it renders an error (422 HTTP code).\n\nAuthorization​: only users that can invite other users. If the user affiliated to the token has the manage_users_of_my_teams permission, the invited user will need to belong to at least one of the teams he’s the leader of. It will not be possible to assign the user to other teams.",
   537          "parameters":[
   538            {
   539              "name":"category_ids",
   540              "in":"query",
   541              "required":false,
   542              "description":"User list of category ids (multiple).",
   543              "schema":{
   544                "type":"array",
   545                "items":{
   546                  "type":"string"
   547                }
   548              }
   549            },
   550            {
   551              "name":"email",
   552              "in":"query",
   553              "required":true,
   554              "description":"User email (mandatory).",
   555              "schema":{
   556                "type":"string"
   557              }
   558            },
   559            {
   560              "name":"enabled",
   561              "in":"query",
   562              "required":false,
   563              "description":"Whether the user is enabled or not (boolean).",
   564              "schema":{
   565                "type":"boolean"
   566              }
   567            },
   568            {
   569              "name":"external_id",
   570              "in":"query",
   571              "required":false,
   572              "description":"User external id.",
   573              "schema":{
   574                "type":"string"
   575              }
   576            },
   577            {
   578              "name":"firstname",
   579              "in":"query",
   580              "required":true,
   581              "description":"User firstname (mandatory).",
   582              "schema":{
   583                "type":"string"
   584              }
   585            },
   586            {
   587              "name":"gender",
   588              "in":"query",
   589              "required":false,
   590              "description":"User gender (\"man\" or \"woman\").",
   591              "schema":{
   592                "type":"string",
   593                "enum":[
   594                  "man",
   595                  "woman"
   596                ]
   597              }
   598            },
   599            {
   600              "name":"identity_ids",
   601              "in":"query",
   602              "required":false,
   603              "description":"User list of identity ids (multiple).",
   604              "schema":{
   605                "type":"array",
   606                "items":{
   607                  "type":"string"
   608                }
   609              }
   610            },
   611            {
   612              "name":"lastname",
   613              "in":"query",
   614              "required":true,
   615              "description":"User lastname (mandatory).",
   616              "schema":{
   617                "type":"string"
   618              }
   619            },
   620            {
   621              "name":"locale",
   622              "in":"query",
   623              "required":false,
   624              "description":"Language for the user interface.",
   625              "schema":{
   626                "type":"string"
   627              }
   628            },
   629            {
   630              "name":"nickname",
   631              "in":"query",
   632              "required":false,
   633              "description":"User nickname.",
   634              "schema":{
   635                "type":"string"
   636              }
   637            },
   638            {
   639              "name":"role_id",
   640              "in":"query",
   641              "required":true,
   642              "description":"User role id (mandatory).",
   643              "schema":{
   644                "type":"string"
   645              }
   646            },
   647            {
   648              "name":"team_ids",
   649              "in":"query",
   650              "required":false,
   651              "description":"User list of team ids (multiple).",
   652              "schema":{
   653                "type":"array",
   654                "items":{
   655                  "type":"string"
   656                }
   657              }
   658            },
   659            {
   660              "name":"timezone",
   661              "in":"query",
   662              "required":false,
   663              "description":"Use the timezone endpoint to get the timezone name (String), default is empty for",
   664              "schema":{
   665                "type":"string"
   666              }
   667            },
   668            {
   669              "name":"spoken_languages",
   670              "in":"query",
   671              "required":false,
   672              "description":"List of locales corresponding to the languages spoken by the user (multiple).",
   673              "schema":{
   674                "type":"array",
   675                "items":{
   676                  "type":"string"
   677                }
   678              }
   679            }
   680          ],
   681          "responses":{
   682            "200":{
   683              "description":"Success",
   684              "content":{
   685                "application/json":{
   686                  "schema":{
   687                    "$ref":"#/components/schemas/User"
   688                  }
   689                }
   690              }
   691            },
   692            "422":{
   693              "description":"Unprocessable Entity"
   694            }
   695          }
   696        }
   697      }
   698    },
   699    "servers":[
   700      {
   701        "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   702      }
   703    ],
   704    "components":{
   705      "schemas":{
   706        "GetAllUsersResponse":{
   707          "properties":{
   708            "count":{
   709              "type":"integer",
   710              "format":"int32"
   711            },
   712            "limit":{
   713              "type":"integer",
   714              "format":"int32"
   715            },
   716            "offset":{
   717              "type":"integer",
   718              "format":"int32"
   719            },
   720            "records":{
   721              "type":"array",
   722              "items":{
   723                "$ref":"#/components/schemas/User"
   724              }
   725            }
   726          }
   727        },
   728        "User":{
   729          "required":[
   730            "id"
   731          ],
   732          "properties":{
   733            "id":{
   734              "type":"string"
   735            },
   736            "created_at":{
   737              "type":"string",
   738              "format":"date-time"
   739            },
   740            "updated_at":{
   741              "type":"string",
   742              "format":"date-time"
   743            },
   744            "category_ids":{
   745              "type":"array",
   746              "items":{
   747                "type":"string"
   748              }
   749            },
   750            "email":{
   751              "type":"string"
   752            },
   753            "enabled":{
   754              "type":"boolean"
   755            },
   756            "external_id":{
   757              "type":"string"
   758            },
   759            "firstname":{
   760              "type":"string"
   761            },
   762            "gender":{
   763              "type":"string"
   764            },
   765            "identity_ids":{
   766              "type":"array",
   767              "items":{
   768                "type":"string"
   769              }
   770            },
   771            "lastname":{
   772              "type":"string"
   773            },
   774            "locale":{
   775              "type":"string"
   776            },
   777            "nickname":{
   778              "type":"string"
   779            },
   780            "rc_user_id":{
   781              "type":"string"
   782            },
   783            "role_id":{
   784              "type":"string"
   785            },
   786            "spoken_languages":{
   787              "type":"array",
   788              "items":{
   789                "type":"string"
   790              }
   791            },
   792            "team_ids":{
   793              "type":"array",
   794              "items":{
   795                "type":"string"
   796              }
   797            },
   798            "timezone":{
   799              "type":"string"
   800            },
   801            "invitation_pending":{
   802              "type":"boolean"
   803            }
   804          }
   805        }
   806      }
   807    }
   808  }