Create Group User

1 from mercoa import Mercoa 2 from mercoa.entity_group_types import ( 3 EntityGroupUserEntityRequest, 4 EntityGroupUserRequest, 5 ) 6 7 client = Mercoa( 8 token="YOUR_TOKEN", 9 ) 10 client.entity_group.user.create( 11 entity_group_id="entg_8545a84e-a45f-41bf-bdf1-33b42a55812c", 12 request=EntityGroupUserRequest( 13 foreign_id="MY-DB-ID-12345", 14 email="john.doe@acme.com", 15 name="John Doe", 16 entities=[ 17 EntityGroupUserEntityRequest( 18 roles=["admin", "approver"], 19 entity_id="ent_21661ac1-a2a8-4465-a6c0-64474ba8181d", 20 ), 21 EntityGroupUserEntityRequest( 22 roles=["viewer"], 23 entity_id="ent_9e02a20e-7749-47de-8d8a-f8ff2859fa90", 24 ), 25 ], 26 ), 27 )

1 { 2 "foreignId": "MY-DB-ID-12345", 3 "entities": [ 4 { 5 "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d", 6 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb", 7 "roles": [ 8 "admin", 9 "approver" 10 ] 11 }, 12 { 13 "entityId": "ent_9e02a20e-7749-47de-8d8a-f8ff2859fa90", 14 "id": "user_3a3aafc8-ea86-408a-a6c1-545497badbbb", 15 "roles": [ 16 "viewer" 17 ] 18 } 19 ], 20 "createdAt": "2024-01-01T00:00:00Z", 21 "updatedAt": "2024-01-01T00:00:00Z", 22 "email": "john.doe@acme.com", 23 "name": "John Doe" 24 }

Create entity user that will be added to all entities in the group.

Path parameters

entityGroupIdstringRequired

Entity Group ID or Entity Group ForeignID

Request

This endpoint expects an object.

foreignIdstringRequired

The ID used to identify this user in your system. This is a required field and needs to be unique for all users in the group.

emailstringOptional

namestringOptional

entitieslist of objectsOptional

List of roles per entity. By default, the user will have no roles.

Response

This endpoint returns an object.

foreignIdstring

The ID used to identify this user in your system.

entitieslist of objects

List of roles per entity.

createdAtdatetime

updatedAtdatetime

emailstringOptional

namestringOptional

Path parameters

Headers

Request

Response

Errors