github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_identities.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":"Identities"
    12        }
    13      ],
    14      "paths":{
    15        "/identities":{
    16          "get":{
    17            "tags":[
    18              "Identities"
    19            ],
    20            "summary":"Getting all identities",
    21            "operationId":"getAllIdentities",
    22            "description":"This method renders identities ordered by creation date (descending). Only identities in sources where token’s user has “read” permission are returned.",
    23            "parameters":[
    24              {
    25                "name":"community_id",
    26                "description":"To filter identities on given community id.",
    27                "in":"query",
    28                "required":false,
    29                "schema":{
    30                  "type":"string"
    31                }
    32              },
    33              {
    34                "name":"identity_group_id",
    35                "description":"To filter on given group id.",
    36                "in":"query",
    37                "required":false,
    38                "schema":{
    39                  "type":"string"
    40                }
    41              },
    42              {
    43                "name":"user_id",
    44                "description":"To filter identities on given user id.",
    45                "in":"query",
    46                "required":false,
    47                "schema":{
    48                  "type":"string"
    49                }
    50              },
    51              {
    52                "name":"sort",
    53                "description":"To change the criteria chosen to sort the identities. The value can be “created_at” or",
    54                "in":"query",
    55                "required":false,
    56                "schema":{
    57                  "type":"string",
    58                  "enum":[
    59                    "created_at",
    60                    "updated_at"
    61                  ]
    62                }
    63              },
    64              {
    65                "name":"foreign_id",
    66                "description":"To filter identities on given user id",
    67                "in":"query",
    68                "required":false,
    69                "schema":{
    70                  "type":"string"
    71                }
    72              },
    73              {
    74                "name":"uuid",
    75                "description":"To filter identities on given uuid",
    76                "in":"query",
    77                "required":false,
    78                "schema":{
    79                  "type":"string"
    80                }
    81              },
    82              {
    83                "name":"offset",
    84                "in":"query",
    85                "description":"The record index to start. Default value is 0.",
    86                "required":false,
    87                "schema":{
    88                  "type":"integer",
    89                  "format":"int32"
    90                }
    91              },
    92              {
    93                "name":"limit",
    94                "in":"query",
    95                "description":"The max number of records to return. Default value is 30, max value is 150.",
    96                "required":false,
    97                "schema":{
    98                  "type":"integer",
    99                  "format":"int32"
   100                }
   101              }
   102            ],
   103            "responses":{
   104              "200":{
   105                "description":"Success",
   106                "content":{
   107                  "application/json":{
   108                    "schema":{
   109                      "$ref":"#/components/schemas/GetAllIdentitiesResponse"
   110                    }
   111                  }
   112                }
   113              }
   114            }
   115          }
   116        },
   117        "/identities/{identityId}":{
   118          "get":{
   119            "tags":[
   120              "Identities"
   121            ],
   122            "summary":"Getting an identity from its id",
   123            "operationId":"getIdentity",
   124            "description":"This method renders an identity from given id. If token’s user does not have “read” on identity’s source community a 404 HTTP response will be returned.",
   125            "parameters":[
   126              {
   127                "name":"identityId",
   128                "in":"path",
   129                "required":true,
   130                "schema":{
   131                  "type":"string"
   132                }
   133              }
   134            ],
   135            "responses":{
   136              "200":{
   137                "description":"Success",
   138                "content":{
   139                  "application/json":{
   140                    "schema":{
   141                      "$ref":"#/components/schemas/Identity"
   142                    }
   143                  }
   144                }
   145              }
   146            }
   147          }
   148        }
   149      },
   150      "servers":[
   151        {
   152          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   153        }
   154      ],
   155      "components":{
   156        "schemas":{
   157          "GetAllIdentitiesResponse":{
   158            "properties":{
   159              "count":{
   160                "type":"integer",
   161                "format":"int32"
   162              },
   163              "limit":{
   164                "type":"integer",
   165                "format":"int32"
   166              },
   167              "offset":{
   168                "type":"integer",
   169                "format":"int32"
   170              },
   171              "records":{
   172                "type":"array",
   173                "items":{
   174                  "$ref":"#/components/schemas/Identity"
   175                }
   176              }
   177            }
   178          },
   179          "Identity":{
   180            "properties":{
   181              "id":{
   182                "type":"string"
   183              },
   184              "created_at":{
   185                "type":"string",
   186                "format":"date-time"
   187              },
   188              "updated_at":{
   189                "type":"string",
   190                "format":"date-time"
   191              },
   192              "community_id":{
   193                "type":"string"
   194              },
   195              "community_url":{
   196                "type":"string"
   197              },
   198              "company":{
   199                "type":"string"
   200              },
   201              "email":{
   202                "type":"string"
   203              },
   204              "firstname":{
   205                "type":"string"
   206              },
   207              "foreign_id":{
   208                "type":"string"
   209              },
   210              "gender":{
   211                "type":"string"
   212              },
   213              "home_phone":{
   214                "type":"string"
   215              },
   216              "identity_group_id":{
   217                "type":"string",
   218                "description":"The identity group id references the identity group that contains all informations (phone, notes, etc.). Many identities may belong to this group. If the identity group id is null, it means that identity does not have a group and any extra information. Please refer to identity groups API for more informations."
   219              },
   220              "lastname":{
   221                "type":"string"
   222              },
   223              "mobile_phone":{
   224                "type":"string"
   225              },
   226              "screenname":{
   227                "type":"string"
   228              },
   229              "user_ids":{
   230                "type":"array",
   231                "items":{
   232                  "type":"string"
   233                }
   234              },
   235              "uuid":{
   236                "type":"string"
   237              },
   238              "extra_values":{
   239                "type":"object"
   240              },
   241              "display_name":{
   242                "type":"string"
   243              },
   244              "avatar_url":{
   245                "type":"string"
   246              },
   247              "type":{
   248                "type":"string"
   249              }
   250            }
   251          }
   252        }
   253      }
   254    }