# info.description
This document describes the Identifying API specifications of Kazi

# paths./clusters.get.parameters[].description
A comma separated list of unique identifiers of clustergroups

# paths./partners/current/profiles.get.summary
Get profiles for partner of current connected client

# paths./partners/current/profiles.get.description
Get profiles for partner of current connected client

# paths./partners/current/profiles.get.parameters[].description
Whether profile should have competences or not

# paths./partners/current/profiles.get.parameters[].description
Whether the returning profiles should include competences or not

# paths./partners/current/profiles.get.parameters[].description
A comma separated list of team role competence ids to filter on

# paths./partners/current/profiles.get.parameters[].description
A comma separated list of work value competence ids

# paths./partners/current/profiles.get.parameters[].description
Format - int32. The offset used for pagination

# paths./partners/current/profiles.get.parameters[].description
Format - int32. The number of records to return. Standard set to 100

# paths./partners/current/profiles.get.parameters[].description
The search string that is used to search on contact name, contact email, title and employer.
            Partial matches are allowed.

# paths./partners/current/profiles.get.responses.200.description
Returns a list of profiles for the current identified partner

# paths./partners/current/profiles.post.requestBody.description
The profile data transfer object with an empty Id. Email is required

# paths./partners/current/profiles.post.responses.200.description
Returns the added profile object with the ID populated

# paths./partners/current/profiles.post.responses.409.description
The profile has already been linked to the partner

# paths./partners/current/users/{userId}.get.summary
Get specific user for partner of connected client

# paths./partners/current/users/{userId}.get.description
Get specific user for partner of connected client

# paths./partners/current/users/{userId}.get.parameters[].description
Whether the returning user should include competences or not

# paths./partners/current/users/{userId}.get.responses.200.description
Returns a specific user linked to the partner of the current connected client

# paths./partners/current/users.get.summary
Get users for partner of connected client

# paths./partners/current/users.get.description
Get users for partner of connected client

# paths./partners/current/users.get.parameters[].description
The unique identifier of the user at partner side

# paths./partners/current/users.get.parameters[].description
Whether user should have competences or not

# paths./partners/current/users.get.parameters[].description
Whether the returned users should include competences or not

# paths./partners/current/users.get.parameters[].description
A comma separated list of team role competence ids to filter on

# paths./partners/current/users.get.parameters[].description
A comma separated list of work value competence ids

# paths./partners/current/users.get.parameters[].description
Format - int32. The offset used for pagination

# paths./partners/current/users.get.parameters[].description
Format - int32. The number of records to return. Standard set to 100

# paths./partners/current/users.get.parameters[].description
The search string that is used to search on name and email. Partial matches are allowed.

# paths./partners/current/users.get.responses.200.description
Returns a list of users linked to the partner of the current connected client

# paths./users.put.parameters[].description
The two-letter iso code for the user's language, eg 'en'

# paths./users.delete.parameters[].description
Comma-separated list of ids of the users to delete

# paths./users.delete.responses.204.description
Returns status code 204 if successfully deleted

# paths./partners/current/{userId}.post.summary
Link user to partner of current connected client

# paths./partners/current/{userId}.post.description
Link user to partner of current connected client

# paths./partners/current/{userId}.post.responses.200.description
Return OK status if User is correctly linked to the partner

# paths./partners/current/me.post.summary
Link current authenticated user to the current connected client partner

# paths./partners/current/me.post.description
Link current authenticated user to the current connected client partner

# paths./partners/current/me.post.responses.200.description
Return OK status if User is correctly linked to the partner

# paths./partners/current/me.post.responses.405.description
Not Allowed if connection is not using authorization grant flow

# paths./partners/{partnerId}/users.get.parameters[].description
Format - uuid. The partner for who you want to get the users

# paths./partners/{partnerId}/users.get.parameters[].description
The unique identifier of the user at partner side

# paths./partners/{partnerId}/users.get.parameters[].description
Whether user should have competences or not

# paths./partners/{partnerId}/users.get.parameters[].description
Whether the returned users should include competences or not

# paths./partners/{partnerId}/users.get.parameters[].description
A comma separated list of team role competence ids to filter on

# paths./partners/{partnerId}/users.get.parameters[].description
A comma separated list of work value competence ids

# paths./partners/{partnerId}/users.get.parameters[].description
Format - int32. The offset used for pagination

# paths./partners/{partnerId}/users.get.parameters[].description
Format - int32. The number of records to return. Standard set to 100

# paths./partners/{partnerId}/users.get.parameters[].description
The search string that is used to search on name and email. Partial matches are allowed.

# paths./partners/{partnerId}/users.get.responses.200.description
Returns a list of users linked to the specified partner

# paths./partners/{partnerId}/profiles.get.parameters[].description
Format - uuid. The partnerId for who you want to get the profiles

# paths./partners/{partnerId}/profiles.get.parameters[].description
Whether profile should have competences or not

# paths./partners/{partnerId}/profiles.get.parameters[].description
Whether the returning profiles should include competences or not

# paths./partners/{partnerId}/profiles.get.parameters[].description
A comma separated list of team role competence ids to filter on

# paths./partners/{partnerId}/profiles.get.parameters[].description
A comma separated list of work value competence ids

# paths./partners/{partnerId}/profiles.get.parameters[].description
Format - int32. The offset used for pagination

# paths./partners/{partnerId}/profiles.get.parameters[].description
Format - int32. The number of records to return. Standard set to 100

# paths./partners/{partnerId}/profiles.get.parameters[].description
The search string that is used to search on contact name, contact email, title and employer.
            Partial matches are allowed.

# paths./partners/{partnerId}/profiles.get.responses.200.description
Returns a list of profiles for the specified partner

# paths./partners/{partnerId}/users/{userId}.get.parameters[].description
Whether the returning user should include competences or not

# paths./partners/{partnerId}/users/{userId}.get.responses.200.description
Returns a specific user linked to the specified partner

# paths./partners/{partnerId}/{userId}.post.responses.200.description
Return OK status if User is correctly linked to the partner

# paths./users/me/partners.get.summary
Get partners for the current authenticated user

# paths./users/me/partners.get.description
Get partners for the current authenticated user

# paths./profiles/{id}.delete.parameters[].description
Format - uuid. The id of the profile to delete

# paths./profiles/{id}.delete.responses.204.description
Returns status code 204 if successfully deleted

# paths./users/{id}.delete.parameters[].description
Format - uuid. The id of the user to delete

# paths./users/{id}.delete.responses.204.description
Returns status code 204 if successfully deleted

# paths./partners/{partnerId}/users/totalcount.get.summary
Get the total number of users for the partner

# paths./partners/{partnerId}/users/totalcount.get.description
Get the total number of users for the partner

# paths./partners/{partnerId}/users/totalcount.get.parameters[].description
Whether the user should have competences or not. This parameter is ignored if there are team role ids or work value ids.

# paths./partners/{partnerId}/users/totalcount.get.parameters[].description
A comma separated list of team role competence ids to filter on

# paths./partners/{partnerId}/users/totalcount.get.parameters[].description
A comma separated list of work value competence ids to filter on

# paths./partners/{partnerId}/users/totalcount.get.parameters[].description
The search string that is used to search on name and email. Partial matches are allowed.

# paths./partners/{partnerId}/users/totalcount.get.responses.200.description
Returns the total number of users for the partner

# paths./partners/{partnerId}/profiles/totalcount.get.summary
Get the total number of profiles for the partner

# paths./partners/{partnerId}/profiles/totalcount.get.description
Get the total number of profiles for the partner

# paths./partners/{partnerId}/profiles/totalcount.get.parameters[].description
Whether the profile should have competences or not.
            This parameter is ignored if there are team role ids or work value ids.

# paths./partners/{partnerId}/profiles/totalcount.get.parameters[].description
A comma separated list of team role competence ids to filter on

# paths./partners/{partnerId}/profiles/totalcount.get.parameters[].description
A comma separated list of work value competence ids to filter on

# paths./partners/{partnerId}/profiles/totalcount.get.parameters[].description
The search string that is used to search on name and email. Partial matches are allowed.

# paths./partners/{partnerId}/profiles/totalcount.get.responses.200.description
Returns the total number of profiles for the partner

# paths./profiles.delete.parameters[].description
Comma-separated list of ids of the profiles to delete

# paths./profiles.delete.responses.204.description
Returns status code 204 if successfully deleted