-
Print
-
DarkLight
-
PDF
Share Object with User
Method for sharing folders, processes, state diagrams, and dashboards with user.

URL
https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{SIGNATURE}}
Request Body
{
"ops": [
{
"type": "create",
"obj": "invite",
"login": {{USER_EMAIL}},
"login_type": "google",
"link_to_obj": "conv",
"link_to_obj_id": {{CONV_ID}},
"privs": [
{
"type": "create",
"list_obj": [
"all"
]
},
{
"type": "modify",
"list_obj": [
"all"
]
},
{
"type": "delete",
"list_obj": [
"all"
]
},
{
"type": "view",
"list_obj": [
"all"
]
}
],
"company_id": {{COMPANY_ID}}
}
]
}
Parameter | Type | Required | Description | Possible value |
---|---|---|---|---|
ops | JSON Object | + | The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations | * The number is user-limited by RPS limit. |
type | string | + | A request type | create |
obj | string | + | An object of request | invite |
login | string | + | An email of an User that you want to share object with | An existing and valid email adress |
login_type | string | - | A type of User login that you want to share object with | corezoid, google |
link_to_obj | string | + | A type of object that you want to share | project, stage, conv, folder, dashboard |
link_to_obj_id | number / number as string | + | An ID of object that you want to share | An ID of an existing Project, Stage, Folder, Process, State diagram or Dashboard |
privs | array | + | An array of user rights settings over shared object | |
privs.type * | string | + | Type of user rights over shared object | create, view, modify, delete |
privs.list_obj | array | + | An array of user right settings over privs.type | all |
company_id | string | - | An ID of an Company, where sharing object stored | An ID of an existing Company |
- create - allows user to create tasks in processes and state diagrams;
- view - allows user to view logic of processes and state diagrams;
- modify - allows user to edit logic of processes and state diagrams;
- delete - allows user to delete object.
Response Body
{
"request_proc": "ok",
"ops": [
{
"id": "",
"obj": "invite",
"proc": "ok"
}
]
}
Parameter | Type | Description | Possible value |
---|---|---|---|
request_proc | string | The overall processing status of all transactions from the request | ok, error |
ops | JSON Object | The list of operations proceeded via Corezoid API. A parameter keeping JSON objects with operations | |
id | string | Request ID | empty |
obj | string | An object of request | invite |
proc | string | The processing status of a specific operation | ok, error |
Show Object Sharing options
Method for showing sharing options of folders, processes, state diagrams, and dashboards with users.
URL
https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{SIGNATURE}}
Request Body
{
"ops": [
{
"type": "list",
"obj": {{OBJ_TYPE}},
"obj_id": {{OBJ_ID}},
"company_id": {{COMPANY_ID}},
"list_obj": "group"
}
]
}
Parameter | Type | Required | Description | Possible value |
---|---|---|---|---|
ops | JSON Object | + | The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations | * The number is user-limited by RPS limit |
type | string | + | Request type | list |
obj | string | + | An object of request | project, stage, version, folder, conv, dashboard |
obj_id | number / number as string | + | An ID of object that you want to get sharing options | An ID of an existing Project, Stage, Version, Folder, Process, State diagram or Dashboard |
company_id | string | - | An ID of an Company, where shared object stored | An ID of an existing Company |
list_obj | string | - | group, all |
Response Body
{
"request_proc": "ok",
"ops": [
{
"project_id": 0,
"stage_id": 0,
"immutable": false,
"id": "",
"obj": "conv",
"obj_id": 780593,
"list_obj": "group",
"proc": "ok",
"list": [
{
"obj": "user",
"obj_id": 76369,
"login_id": 76369,
"title": "Fedor Eviy",
"privs": [
{
"type": "view",
"list_obj": [
"all"
]
},
{
"type": "create",
"list_obj": [
"all"
]
},
{
"type": "delete",
"list_obj": [
"all"
]
},
{
"type": "modify",
"list_obj": [
"all"
]
}
],
"login": "feviy86961@demail3.com"
},
{
"obj": "user",
"obj_id": 76392,
"login_id": 76392,
"title": "API key",
"privs": [
{
"type": "create",
"list_obj": [
"all"
]
}
],
"login": ""
},
{
"obj_id": 128076,
"obj": "group",
"title": "Badasses",
"obj_type": "admins",
"obj_status": "actived",
"privs": [
{
"type": "view",
"list_obj": [
"all"
]
}
]
},
{
"obj": "user",
"title": "sofiya.zelenskaya@corezoid.com",
"privs": [
{
"type": "create",
"list_obj": [
"all"
]
},
{
"type": "modify",
"list_obj": [
"all"
]
},
{
"type": "delete",
"list_obj": [
"all"
]
},
{
"type": "view",
"list_obj": [
"all"
]
}
],
"is_invite": true,
"invite_hash": "1227fe24fa135894205f58398a68ba574341bbbf"
}
]
}
]
}
Parameter | Type | Description | Possible value |
---|---|---|---|
request_proc | string | The overall processing status of all transactions from the request | ok, error |
ops | JSON Object | The list of operations proceeded via Corezoid API. A parameter keeping JSON objects with operations | |
project_id | string | + | Project ID |
stage_id | string | + | Stage ID |
immutable | boolean | + | Indicates whether the stage is immutable |
obj | string | An object of request | folder, conv, dashboard |
obj_id | number | An ID of object that you request to get sharing options | folder, conv, dashboard |
proc | string | The processing status of a specific operation | ok, error |
list | array | The list of Users and their rights to requested object | An array of users or API Keys |
list.obj | sting | Type of User that has access to object | user, group |
list.obj_id | number | Id of User, API Key or User Group that has access to object | An ID of User, API Key or Users Group |
list.title | string | A login of User, API Key or Users Group name | A name of User, API Key or Users Group |
list.privs | array | An array of users rights settings over shared object | view, create, modify, delete |
list.login_id | number | (ONLY FOR User OR API Key) Id of User or API Key that has access to object | An ID of User or API Key |
list.login | string | (ONLY FOR User) A login of User that has access to object | An Login of User |
list.obj_type | string | (ONLY FOR Users Group) Type of Users Group | admins, supers, company |
list.obj_status | string | (ONLY FOR Users Group) Status of Users Group | actived |
list.is_invite | boolean | (ONLY FOR PENDING Invites) Status of Invitation | true |
list.invite_hash | string | (ONLY FOR PENDING Invites) Hash of Invitation |
Change Share Options
Method for sharing folders, processes, state diagrams, and dashboards with user.
URL
https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{SIGNATURE}}
Request Body
{
"ops": [
{
"type": "link",
"obj": {{OBJ_TYPE}},
"obj_id": {{OBJ_ID}},
"obj_to": {{USER_TYPE}},
"obj_to_id": {{USER_ID}}},
"privs": [
{
"type": {{ACCESS_TYPE}},
"list_obj": [
"all"
]
},
....
{
"type": {{ACCESS_TYPE}},
"list_obj": [
"all"
]
}
],
"company_id": {{COMPANY_ID}}
}
]
}
Parameter | Type | Required | Description | Possible value |
---|---|---|---|---|
ops | JSON Object | + | The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations | * The number is user-limited by RPS limit. |
type | string | + | A request type | link |
obj | string | + | An object of request | conv, folder, dashboard |
obj_id | string | + | An ID of object of request | An ID of an existing Project, Stage, Folder, Process, State diagram or Daashboard |
obj_to | string | + | A type of User | user, group |
obj_to_id | string | + | An ID of User, API key or Users Group | An ID of an existing User, API Key or Users Group |
privs * | array | + | An array of User rights settings over shared object | |
privs.type ** | string | + | Type of user rights over shared object | create, view, modify, delete |
privs.list_obj | array | + | An array of user right settings over privs.type | all |
company_id | string | - | An ID of an Company, where sharing object is stored | An ID of an existing Company |
- pass empty array to remove access;
- create - allows user to create tasks in processes and state diagrams;
- view - allows user to view logic of processes and state diagrams;
- modify - allows user to edit logic of processes and state diagrams;
- delete - allows user to delete object.
Response Body
{
"request_proc": "ok",
"ops": [
{
"id": "",
"proc": "ok",
"obj_type": "conv",
"obj_id": 780777,
"obj_to_type": "user",
"obj_to_id": 74492,
"obj_to_title": "API key",
"action_type": "link"
}
]
}
Parameter | Type | Description | Possible value |
---|---|---|---|
request_proc | string | The overall processing status of all transactions from the request | ok, error |
ops | JSON Object | The list of operations proceeded via Corezoid API. A parameter keeping JSON objects with operations | |
id | string | Request ID | empty |
proc | string | The processing status of a specific operation | ok, error |
obj_type | string | A type of shared object | project, stage, folder, conv, dashboard |
obj_id | number | An ID of shared object | |
obj_to_type | array | Type of User that has access to object | user, group |
obj_to_id | sting | An ID of User or Group | |
obj_to_title | string | A login of User or Users Group name | A name of User or Users Group |
action_type | array | An array of users rights settings over shared object | link, unlink |