--- title: "/Endpoint/rest/api/v1/GroupExternal/{Id}/UserExternals" slug: "endpointrestapiv1groupexternaliduserexternals-3" updated: 2024-12-18T10:21:23Z published: 2024-12-18T10:21:23Z canonical: "docs.agilenow.io/endpointrestapiv1groupexternaliduserexternals-3" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.agilenow.io/llms.txt > Use this file to discover all available pages before exploring further. # /Endpoint/rest/api/v1/GroupExternal/{Id}/UserExternals Patch/Endpoint/rest/api/v1/GroupExternal/{Id}/UserExternals Use the `UserExternalsData` object resource to insert or update (Upsert) a list of `UserExternalData` using `Id` field(s) value. You can supply the required field values in the request data, and then use the `POST` method of the resource. The input parameter must be used in the `UserExternalList` record structure as text fields in the foreign key fields. Foreign key fields are: `User_Id, Group_Id` ### Update a record of UserExternal - When the Id field value is not provided, the system will automatically initiate the insertion of a new record. **Attention!**, this can also cause an incorrect row update, but at the same time enables efficient data transfer between systems. ### Create a new record of UserExternal - If the value in the `Id` field is empty then action insert a new record according input parameter entity record structure (`UserExternalData`). The response body will contain the record list structure of the updated or created record if the call is successful. The method returns a list structured with an extended `UserExternal` representation. In this format, all foreign key fields are depicted as abstract object structures, employing `AbstractText` or `AbstractLong` data types. This offers an enriched and detailed perspective of the data and its associated entities. SecurityOAuth oAuth autentication flow FlowClient Credentials Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token Scopes:AccessManager:Create, UpdateAllows to edit access groups and all related data. (ABAC) permissions required to perform a function. AccessUser:Create, UpdateAllows to review access groups and all related data. (ABAC) permissions required to perform a function. Path parametersIdstringRequired The identifier of the GroupExternal record. The parameter is part of the url address and some special characters are forbidden. You can extract any string to a base64 string. E.g email address name@domain.com value is base64|bmFtZUBkb21haW4uY29t Query parametersNamestring The name of the database field. If empty, the entity `Id` field is used. Example: ``` Id ``` DeleteNotExistsstring The Delete not exists function delete orphan values from a table. If you specify value, you do not need to manually delete orphan rows from the table, the service retrieves the result set and if it is not found from the json string, then delete orphan rows from the table. Default"false" Body parameters The list of UserExternal information to insert or update. The input parameter must be used in the `Extra` record array structure inside the `Name` and `FieldName` parameters in the foreign key fields. Expand Allobject The data loading record of UserExternal importing Extra Array of object (ListValidation) List validation for entity attribute object List validation for entity attribute Namestring Required The name of the entity field. FieldNamestring The field name of relation database table. Example; The field name is 'TenantId' and is associated with the 'Tenant' table. You want to use in the 'Tenant' table 'Name' field fetching data. Once 'Name' is specified, the validation service retrieves the tenant identifier from the 'Tenant' table based on the 'Name' field. Requiredboolean If True, the value is required. DefaultfalseExampleFalse Uniqueboolean If True, the value must be unique in the database and you cannot add multiple values. DefaultfalseExampleFalse Maxstring The max value of input value. Minstring The min value of input value. Patternstring The pattern of the validation. Searches the input string for an occurrence of a regular expression. DefaultValuestring The default value of row. If the value of the field is empty, the service automatically sets the value in the field. If the value does not match the data type, the value is cleaned. Remember data types. IsFullValidationboolean If the value is true, the data quality of all fields are checked. This has an effect on performance. DefaultfalseExampleFalse UserExternals Array of object (UserExternalText) The list of `UserExternal` data record for import object The record of UserExternal information. User_Idstring Responses200 Inserted or updated list of UserExternal information. Expand Allobject The list of `UserExternal` records Metaobject (Meta) The object provides metadata about the list of items returned in the API response. It typically includes information that helps clients understand and work with the data. TotalItemsinteger (int32) This field represents the total number of items available in the entire dataset, not just the items returned in the current response. It's useful for implementing pagination, as clients can use it to calculate the number of pages or total available items. Default0Example1000 CurrentPageinteger (int32) This field specifies the current page of results being returned. It's often used in conjunction with `PageSize` to manage pagination by indicating which subset of the total data is currently being retrieved. Default1Example50 PageSizeinteger (int32) The field indicates the number of items returned in a single page or response. It helps clients determine how many items to display per page and how to request additional pages if needed. Default50Example50 Typestring The type of the record ExampleUser Data Array of object (UserExternal) The list of `UserExternal records` object The record of UserExternal information. Idinteger (int32) Unique identifier of the user. Default0Example0 Namestring Full name of the user. Usernamestring Login name of the user. Emailstring Email contact of the user. MobilePhonestring Mobile phone number of the user. External_Idstring The user identifier in an external system to the Platform. Creation_Datestring (date-time) The date the user was created. Default"1900-01-01T12:00:00Z"Example1900-01-01T12:00:00Z Last_Loginstring (date-time) Last time the user logged in the application. Default"1900-01-01T12:00:00Z"Example1900-01-01T12:00:00Z Is_Activeboolean Indicates if the user is still active. DefaultfalseExampleFalse 400 Bad Request - The user has provided input that the browser is unable to convert. ```json { "Errors": [ "The user has provided input that the browser is unable to convert.", "There are multiple rows in the database for the same value", "The value does not match the specified entity structure", "..." ], "Type": "/Errors/Bad Input", "Title": "Bad Request", "StatusCode": 400, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 401 Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. ```json { "Errors": [ "The session Id or OAuth token used has expired or is invalid." ], "Type": "/Errors/Unauthorized", "Title": "Unauthorized", "StatusCode": 401, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 403 Forbidden - The user does not have access to execute operation ```json { "Errors": [ "The user does not have access to execute operation" ], "Type": "/Errors/Permission", "Title": "Bad Request", "StatusCode": 403, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 500 Internal Server Error - An internal server error is an error on the web server you're trying to access. ```json { "Errors": [ "An internal server error is an error on the web server you're trying to access." ], "Type": "/Errors/Internal Server Error", "Title": "Internal Server Error", "StatusCode": 500, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default""