Roles

Roles endpoints

The Roles endpoint enable you to list, create, update and delete roles in your Quantive Results account.

get

/roles

Gets all roles in the account.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
fields	string	List of fields to be retrieved, separated by comas (,). expected in query, sample value: `name,description`
sort	string	List of fields separated by comas (,). To invert a field's sort, you can prefix its name with a minus (-). For example, the following expression: sort=-name,dateCreated would return entities in reverse lexicographical order and then ordered by dateCreated. expected in query, sample value: `-name,dateCreated`
filter	string	The format of the parameter is inspired by the MongoDB query format. For example, the following expression {name: {$in: ["sales", "marketing"]}} would return all the entities that have name either "sales" or "marketing". This expression {"name":{$regex:".Sales."}} would return entities that contain "Sales" in their names. expected in query, sample value: `{name: {$in: ["sales", "marketing"]}}`
skip	integer	How many entities to be skipped when executing a GET query. By default skip value is 0. expected in query, sample value: `5`
limit	integer	The max number of entities that can be returned by the GET query. By default take value is 100. expected in query, sample value: `10`
formatting	string	The formatting used for the description and custom fields of type text area. By default returned as 'mentionsMarkup'. Ex: "@[John Smith:john.smith@okrs.tech:602a65efc05575000123291b]". Use 'plainText' if you need the response to be returned without markdown and special markup. Ex: "@John Smith" expected in query, sample value: `plainText`

Expected response codes

`200`	`rolesV2Response`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v2/roles?fields=name,description&sort=-name,dateCreated&filter={name: {$in: ["sales", "marketing"]}}&skip=5&limit=10&formatting=plainText' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v2/roles?fields=name,description&sort=-name,dateCreated&filter={name: {$in: ["sales", "marketing"]}}&skip=5&limit=10&formatting=plainText",
 "method": "GET",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v2/roles"



requests.get(url, headers = headers)

{
    "items": [
        {
            "accountId": "string value",
            "description": "string value",
            "id": "string value",
            "name": "string value",
            "userCount": 2
        }
    ],
    "totalCount": 2
}

🔗

get

/roles/account/mapping/

SCIM groups existence check

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`200`	`ok`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/roles/account/mapping/' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/mapping/",
 "method": "GET",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/mapping/"



requests.get(url, headers = headers)

🔗

get

/roles/account/mapping/scim-groups/exists

SCIM groups existence check

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`200`	`ok`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/roles/account/mapping/scim-groups/exists' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/mapping/scim-groups/exists",
 "method": "GET",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/mapping/scim-groups/exists"



requests.get(url, headers = headers)

🔗

get

/roles/account/scim-groups/

Get all scim groups available to be mapped to roles for an account

Parameters

Name	Type	Description

Expected response codes

`201`	`groupsResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/roles/account/scim-groups/' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/scim-groups/",
 "method": "GET",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/scim-groups/"



requests.get(url, headers = headers)

{
    "items": [
        {
            "accountId": "string value",
            "displayName": "string value",
            "id": "string value",
            "memberIds": [
                "string value 1",
                "string value 2"
            ]
        }
    ],
    "totalCount": 2
}

🔗

get

/roles/{id}

Gets the role with the specified id.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
id *	string	Specifies the role ID. expected in path, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`200`	`roleResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/roles/{id}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/{id}",
 "method": "GET",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/{id}"



requests.get(url, headers = headers)

{
    "accountId": "string value",
    "description": "string value",
    "id": "string value",
    "name": "string value",
    "teamId": "string value",
    "userCount": 2
}

🔗

post

/roles/account

Creates a new account specific role in the system.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`201`	`roleResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/roles/account' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account"



requests.post(url, headers = headers)

{
    "accountId": "string value",
    "description": "string value",
    "id": "string value",
    "name": "string value",
    "teamId": "string value",
    "userCount": 2
}

🔗

post

/roles/account/delete-mappings

Delete multiple role mappings for an account

Parameters

Name	Type	Description

Expected response codes

`204`	`no content`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/roles/account/delete-mappings' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/delete-mappings",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/delete-mappings"



requests.post(url, headers = headers)

🔗

post

/roles/account/mapping

Creates a new roles mappings.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`201`	`roleResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/roles/account/mapping' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/mapping",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/mapping"



requests.post(url, headers = headers)

{
    "accountId": "string value",
    "description": "string value",
    "id": "string value",
    "name": "string value",
    "teamId": "string value",
    "userCount": 2
}

🔗

post

/users/roles/recalculate-scim-roles

Recalculate roles from SCIM provisioning

Parameters

Name	Type	Description

Expected response codes

`200`	`no content`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/roles/recalculate-scim-roles' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/roles/recalculate-scim-roles",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/users/roles/recalculate-scim-roles"



requests.post(url, headers = headers)

🔗

put

/roles/account/mapping

Creates or updates role mappings.

Parameters

Name	Type	Description

Expected response codes

`200`	`roleMappingsResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X PUT 'https://app.quantive.com/results/api/v1/roles/account/mapping' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/mapping",
 "method": "PUT",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/mapping"



requests.put(url, headers = headers)

[
    {
        "accountId": "string value",
        "excludeOnUpdate": false,
        "externalRole": "string value",
        "id": "string value",
        "internalRole": "string value",
        "isDefault": false
    }
]

🔗

put

/roles/account/{id}

Updates the role by id.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
id *	string	Specifies the role ID. expected in path, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`200`	`roleResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X PUT 'https://app.quantive.com/results/api/v1/roles/account/{id}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/{id}",
 "method": "PUT",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/{id}"



requests.put(url, headers = headers)

{
    "accountId": "string value",
    "description": "string value",
    "id": "string value",
    "name": "string value",
    "teamId": "string value",
    "userCount": 2
}

🔗

delete

/roles/account/mapping/{id}

Delete a role mapping for an account

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`204`	`no content`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X DELETE 'https://app.quantive.com/results/api/v1/roles/account/mapping/{id}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/mapping/{id}",
 "method": "DELETE",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/mapping/{id}"



requests.delete(url, headers = headers)

🔗

delete

/roles/account/{id}

Deletes the specified account specific role.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
id *	string	Specifies the role ID. expected in path, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`204`	`no content`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X DELETE 'https://app.quantive.com/results/api/v1/roles/account/{id}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/roles/account/{id}",
 "method": "DELETE",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 }
};
$.ajax(settings).done(function (response) {
 console.log(response);
});

 NOTE: You must install the module requests.
 In a terminal window do: pip install requests



import requests, json 

headers = {
 "Authorization" : "Bearer {token}",
 "gtmhub-accountId" : "{accountId}",
 "Content-Type" : "application/json"
}; 

url = "https://app.quantive.com/results/api/v1/roles/account/{id}"



requests.delete(url, headers = headers)

Oops! Looks like there are no API calls of that type for this Endpoint