Microsoft Azure DevOps
48 min
the microsoft azure devops connector allows seamless integration with azure devops services, enabling automated management and operations within the devops environment microsoft azure devops is a suite of development tools for software teams, offering a rich set of capabilities from project planning and source code management to build and release management the azure devops connector for swimlane turbine enables seamless integration, allowing users to manage users, access entitlements, and handle personal access tokens (pats) directly within the swimlane platform by leveraging this connector, security teams can automate user management and access control tasks, ensuring compliance and enhancing security posture within their devops environment the connector's actions are designed to streamline operations and reduce manual effort, providing a more efficient and secure workflow prerequisites to utilize the microsoft azure devops connector with swimlane turbine, ensure you have the following http basic authentication with the following parameters username the username used to log into azure devops personal access token (pat) a token used in place of a password to access azure devops rest apis url the base url for the azure devops instance you wish to connect to capabilities this connector provides the following capabilities delete user get organizations list get user entitlements get user get users list list pats revoke pats configurations http basic authentication authenticates using username and pat configuration parameters parameter description type required url url string required username username string required password personal access token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions delete user removes a specified user from an azure devops organization using their userid and requires the api version parameter endpoint url https //vsaex dev azure com/{{organization}}/ apis/userentitlements/{{userid}} method delete input argument name type required description input argument name type required description organization string required parameter for delete user userid string required unique identifier api version string required parameter for delete user output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text example \[ { "status code" 200, "response headers" { "cache control" "no cache, no store, must revalidate", "pragma" "no cache", "expires" " 1", "p3p" "cp=\\"cao dsp cor adma dev cono telo cur psa psd tai ivdo our sami bus dem nav sta ", "set cookie" "vstssession=%7b%22persistentsessionid%22%3a%2209cd44b8 efd8 4435 ac5f cbfc5411f9 ", "x tfs processid" "c031a33a df9e 4fe9 83dd 6d9bb2d000d4", "strict transport security" "max age=31536000; includesubdomains", "activityid" "0e5a0902 6357 4e49 a012 4b020e217769", "x tfs session" "0e5a0902 6357 4e49 a012 4b020e217769", "x vss e2eid" "0e5a0902 6357 4e49 a012 4b020e217769", "x vss senderdeploymentid" "0444d719 954b 4970 8216 09ea10adddc8", "x vss userdata" "e9b6a93c 5610 69d2 88fc 52ad16e266d0\ nick allen\@swimlane com", "x frame options" "sameorigin", "request context" "appid=cid v1 265bee8c bd34 4bf3 977c 60df1117b5fb", "access control expose headers" "request context" }, "reason" "no content", "response text" "" } ] get organizations list retrieves a list of organizations associated with the provided credentials in microsoft azure devops, requiring 'organization' and 'api version' endpoint url https //dev azure com/{{organization}}/ apis/contribution/hierarchyquery method post input argument name type required description input argument name type required description organization string required parameter for get organizations list api version string required parameter for get organizations list contributionids array required unique identifier dataprovidercontext object optional response data properties object optional parameter for get organizations list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase dataprovidershareddata object response data featureflags object output field featureflags visualstudio services adminengagement organizationoverview\ editableorganizationavatar boolean output field visualstudio services adminengagement organizationoverview\ editableorganizationavatar dataproviders object response data ms vss web component data object response data ms vss web shared data object response data ms vss features my organizations data provider object response data organizations array output field organizations id string unique identifier name string name of the resource url string url endpoint for the request avatarurl string url endpoint for the request mostrecentlyaccessedhosts array output field mostrecentlyaccessedhosts createneworgurl string url endpoint for the request isuseraccountmappingrequired boolean output field isuseraccountmappingrequired example \[ { "status code" 200, "response headers" { "cache control" "no cache, no store, must revalidate", "pragma" "no cache", "content length" "582", "content type" "application/json; charset=utf 8; api version=7 1 preview\ 1", "content encoding" "gzip", "expires" " 1", "vary" "accept encoding", "p3p" "cp=\\"cao dsp cor adma dev cono telo cur psa psd tai ivdo our sami bus dem nav sta ", "set cookie" "vstssession=%7b%22persistentsessionid%22%3a%22bbd6aa66 fe47 41db 8044 6920e694f3 ", "x tfs processid" "183dff5b 2afe 49c2 8aa2 b9e828934e0a", "strict transport security" "max age=31536000; includesubdomains", "activityid" "b2440f85 1504 4328 937c 1584232b7d6a", "x tfs session" "b2440f85 1504 4328 937c 1584232b7d6a", "x vss e2eid" "b2440f85 1504 4328 937c 1584232b7d6a", "x vss senderdeploymentid" "f466e928 5898 edb4 7123 84c15666043f" }, "reason" "ok", "json body" { "dataprovidershareddata" {}, "dataproviders" {} } } ] get user fetches a specific user's details from microsoft azure devops using their descriptor and organization information endpoint url https //vssps dev azure com/{{organization}}/ apis/graph/users/{{userdescriptor}} method get input argument name type required description input argument name type required description organization string required parameter for get user userdescriptor string required parameter for get user api version string required parameter for get user output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase subjectkind string output field subjectkind domain string output field domain principalname string name of the resource mailaddress string output field mailaddress origin string output field origin originid string unique identifier displayname string name of the resource links object output field links self object output field self href string output field href memberships object output field memberships href string output field href membershipstate object output field membershipstate href string output field href storagekey object output field storagekey href string output field href avatar object output field avatar href string output field href url string url endpoint for the request descriptor string output field descriptor example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "subjectkind" "string", "domain" "string", "principalname" "example name", "mailaddress" "string", "origin" "string", "originid" "string", "displayname" "example name", " links" {}, "url" "https //example com/api/resource", "descriptor" "string" } } ] get user entitlements retrieve entitlement information for a specified user in an azure devops organization, requiring organization id, user id, and api version endpoint url https //vsaex dev azure com/{{organization}}/ apis/userentitlements/{{userid}} method get input argument name type required description input argument name type required description organization string required parameter for get user entitlements userid string required unique identifier api version string required parameter for get user entitlements output parameter type description parameter type description id string unique identifier user object output field user subjectkind string output field subjectkind metatype string type of the resource domain string output field domain principalname string name of the resource mailaddress string output field mailaddress origin string output field origin originid string unique identifier displayname string name of the resource links object output field links self object output field self href string output field href memberships object output field memberships href string output field href membershipstate object output field membershipstate href string output field href storagekey object output field storagekey href string output field href url string url endpoint for the request descriptor string output field descriptor accesslevel object output field accesslevel licensingsource string output field licensingsource accountlicensetype string type of the resource example \[ { "id" "fe2f1bdb 9779 491a a6f6 c6e9322cfb00", "user" { "subjectkind" "user", "metatype" "member", "domain" "14c5367e ee12 4c94 98b8 b52c1fe3cfb1", "principalname" "user1\@fabrikam com", "mailaddress" "user1\@fabrikam com", "origin" "aad", "originid" "00000000 0000 0000 0000 000000000000", "displayname" "user 1", " links" {}, "url" "https //vssps dev azure com/fabrikam/ apis/graph/users/aad wugm3idz1utzzczntktzm ", "descriptor" "aad wugm3idz1utzzczntktzmjwlirzy30ynye2mtcdnmftozmjy" }, "accesslevel" { "licensingsource" "account", "accountlicensetype" "stakeholder", "msdnlicensetype" "none", "licensedisplayname" "stakeholder", "status" "active", "statusmessage" "", "assignmentsource" "unknown" }, "lastaccesseddate" "0001 01 01t00 00 00z", "projectentitlements" \[], "extensions" \[], "groupassignments" \[] } ] get users list retrieve a list of all users within the specified organization in microsoft azure devops, requiring 'organization' and 'api version' endpoint url https //vssps dev azure com/{{organization}}/ apis/graph/users method get input argument name type required description input argument name type required description organization string required parameter for get users list api version string required parameter for get users list continuationtoken string optional parameter for get users list scopedescriptor string optional parameter for get users list subjecttypes array optional type of the resource output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase count number count value value array value for the parameter subjectkind string output field subjectkind domain string output field domain principalname string name of the resource mailaddress string output field mailaddress origin string output field origin originid string unique identifier displayname string name of the resource links object output field links self object output field self href string output field href memberships object output field memberships href string output field href membershipstate object output field membershipstate href string output field href storagekey object output field storagekey href string output field href avatar object output field avatar href string output field href url string url endpoint for the request descriptor string output field descriptor example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "count" 123, "value" \[] } } ] list pats retrieve a list of personal access tokens (pats) for a specified user within an azure devops organization, requiring organization, user descriptor, and api version endpoint url https //vssps dev azure com/{{organization}}/ apis/tokenadmin/personalaccesstokens/{{userdescriptor}} method get input argument name type required description input argument name type required description organization string required parameter for list pats userdescriptor string required parameter for list pats api version string required parameter for list pats continuationtoken string optional parameter for list pats ispublic boolean optional parameter for list pats pagesize number optional parameter for list pats output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase value array value for the parameter clientid string unique identifier accessid string unique identifier authorizationid string unique identifier hostauthorizationid string unique identifier userid string unique identifier validfrom string unique identifier validto string unique identifier displayname string name of the resource scope string output field scope targetaccounts array output field targetaccounts token object output field token alternatetoken object output field alternatetoken isvalid boolean unique identifier ispublic boolean output field ispublic publicdata object response data source object output field source claims object output field claims continuationtoken object output field continuationtoken example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "value" \[], "continuationtoken" {} } } ] revoke pats revokes personal access tokens (pats) in microsoft azure devops for a specified organization requires 'organization' as path parameter and 'api version' endpoint url https //vssps dev azure com/{{organization}}/ apis/tokenadmin/revocations method post input argument name type required description input argument name type required description organization string required parameter for revoke pats api version string required parameter for revoke pats ispublic boolean optional parameter for revoke pats authorizationid string optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response text" "string" } ] response headers header description example access control expose headers http response header access control expose headers request context activityid http response header activityid b2440f85 1504 4328 937c 1584232b7d6a cache control directives for caching mechanisms no cache, no store, must revalidate content encoding http response header content encoding gzip content length the length of the response body in bytes 472 content type the media type of the resource application/json date the date and time at which the message was originated wed, 08 nov 2023 07 59 03 gmt expires the date/time after which the response is considered stale 1 p3p http response header p3p cp="cao dsp cor adma dev cono telo cur psa psd tai ivdo our sami bus dem nav sta uni com int phy onl fin pur loc cnt" pragma http response header pragma no cache request context http response header request context appid=cid v1 \ ba8cca98 f9cc 4f08 a334 706ff8d04ac6 set cookie http response header set cookie vstssession=%7b%22persistentsessionid%22%3a%22bbd6aa66 fe47 41db 8044 6920e694f3eb%22%2c%22pendingauthenticationsessionid%22%3a%2200000000 0000 0000 0000 000000000000%22%2c%22currentauthenticationsessionid%22%3a%2200000000 0000 0000 0000 000000000000%22%2c%22signinstate%22%3a%7b%7d%7d;samesite=none; domain= dev azure com; expires=thu, 07 nov 2024 07 19 33 gmt; path=/; secure; httponly strict transport security http response header strict transport security max age=31536000; includesubdomains vary http response header vary accept encoding x cache http response header x cache config nocache x content type options http response header x content type options nosniff x frame options http response header x frame options sameorigin x msedge ref http response header x msedge ref ref a 369cd54872d04777a17806aafbac6605 ref b bom02edge0511 ref c 2023 11 08t07 19 33z x tfs processid http response header x tfs processid c031a33a df9e 4fe9 83dd 6d9bb2d000d4 x tfs session http response header x tfs session b2440f85 1504 4328 937c 1584232b7d6a x vss e2eid http response header x vss e2eid b2440f85 1504 4328 937c 1584232b7d6a x vss senderdeploymentid http response header x vss senderdeploymentid f466e928 5898 edb4 7123 84c15666043f x vss userdata http response header x vss userdata e9b6a93c 5610 69d2 88fc 52ad16e266d0 \ nick allen\@swimlane com mailto allen\@swimlane com notes azure devops api documentation https //learn microsoft com/en us/rest/api/azure/devops/account/accounts/list?view=azure devops rest 7 2\&tabs=http