Skip to content

Identities API documentation does not reflect actual behaviour #732

@aklakina

Description

@aklakina

The Identities API's currently documented behaviour

By documentation the API accepts the following query parameters:

  • searchFilter
  • filterValue

When these are provided, the API shall respond with a group of matching filter however the response is a System.ArgumentException from azure devops both services and server.

The Identities API's actual behaviour

From a plain request to the endpoint https://dev.azure.com/{collection}/_apis/identities, we can observe the expected query parameters which are:

  • searchFactor
  • factorValue

Severity of this issue

As the GO and Python SDKs are generated based on this API specification, both SDKs are currently broken and thus you can not actually query any identity object through the sdk. This only affects azure devops server as the services instance has the graph API available as a workaround.

Today I could look into this issue more in details. The SDKs are not affected but the behaviour is different. Pure rest api requests to the application need the searchFactor and factorValue query params, while the SDKs are correctly using the searchFilter and filterValue params.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions