Microsoft Azure DevOps
35 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 notes https //learn microsoft com/en us/rest/api/azure/devops/account/accounts/list?view=azure devops rest 7 2\&tabs=http 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 path parameters organization string required parameters for the delete user action path parameters userid string required parameters for the delete user action parameters api version string required parameters for the delete user action input example {"parameters" {"api version" "7 1 preview\ 3"},"path parameters" {"organization" "swimlane test","userid" "ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} 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 output 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 tf 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 path parameters organization string required parameters for the get organizations list action parameters api version string required parameters for the get organizations list action contributionids array optional unique identifier dataprovidercontext object optional response data dataprovidercontext properties object optional response data input example {"parameters" {"api version" "7 1 preview\ 1"},"json body" {"contributionids" \["ms vss features my organizations data provider"],"dataprovidercontext" {"properties" {}}},"path parameters" {"organization" "swimlane test"}} output parameter type description status code number http status code of the response reason string response reason phrase dataprovidershareddata object response data dataprovidershareddata featureflags object response data dataprovidershareddata featureflags visualstudio services adminengagement organizationoverview\ editableorganizationavatar boolean response data dataproviders object response data dataproviders ms vss web component data object response data dataproviders ms vss web shared data object response data dataproviders ms vss features my organizations data provider object response data dataproviders ms vss features my organizations data provider organizations array response data dataproviders ms vss features my organizations data provider organizations id string response data dataproviders ms vss features my organizations data provider organizations name string response data dataproviders ms vss features my organizations data provider organizations url string response data dataproviders ms vss features my organizations data provider organizations avatarurl string response data dataproviders ms vss features my organizations data provider mostrecentlyaccessedhosts array response data dataproviders ms vss features my organizations data provider createneworgurl string response data dataproviders ms vss features my organizations data provider isuseraccountmappingrequired boolean response data output 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 2a 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 path parameters organization string required parameters for the get user action path parameters userdescriptor string required parameters for the get user action parameters api version string required parameters for the get user action input example {"parameters" {"api version" "7 1 preview\ 1"},"path parameters" {"organization" "swimlane test","userdescriptor" "msa ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} 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 links self object output field links self links self href string output field links self href links memberships object output field links memberships links memberships href string output field links memberships href links membershipstate object output field links membershipstate links membershipstate href string output field links membershipstate href links storagekey object output field links storagekey links storagekey href string output field links storagekey href links avatar object output field links avatar links avatar href string output field links avatar href url string url endpoint for the request descriptor string output field descriptor output example {"subjectkind" "string","domain" "string","principalname" "example name","mailaddress" "string","origin" "string","originid" "string","displayname" "example name"," links" {"self" {"href" "string"},"memberships" {"href" "string"},"membershipstate" {"href" "string"},"storagekey" {"href" "string"},"avatar" {"href" "string"}},"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 path parameters organization string required parameters for the get user entitlements action path parameters userid string required parameters for the get user entitlements action parameters api version string required parameters for the get user entitlements action input example {"parameters" {"api version" "7 1 preview\ 3"},"path parameters" {"organization" "swimlane test","userid" "ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} output parameter type description id string unique identifier user object output field user user subjectkind string output field user subjectkind user metatype string type of the resource user domain string output field user domain user principalname string name of the resource user mailaddress string output field user mailaddress user origin string output field user origin user originid string unique identifier user displayname string name of the resource user links object output field user links user links self object output field user links self user links self href string output field user links self href user links memberships object output field user links memberships user links memberships href string output field user links memberships href user links membershipstate object output field user links membershipstate user links membershipstate href string output field user links membershipstate href user links storagekey object output field user links storagekey user links storagekey href string output field user links storagekey href user url string url endpoint for the request user descriptor string output field user descriptor accesslevel object output field accesslevel accesslevel licensingsource string output field accesslevel licensingsource accesslevel accountlicensetype string type of the resource accesslevel msdnlicensetype string type of the resource output 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" {"self" {},"memberships" {},"membershipstate" {},"storagekey" {}},"url" "https //vssps dev azure com/fabrikam/ apis/graph/users/aad wugm3idz1utzzczntktzm ","descriptor" "aad wugm3idz1utzz 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 path parameters organization string required parameters for the get users list action parameters api version string required parameters for the get users list action parameters continuationtoken string optional parameters for the get users list action parameters scopedescriptor string optional parameters for the get users list action parameters subjecttypes array optional parameters for the get users list action input example {"path parameters" {"organization" "swimlane test"}} 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 value subjectkind string value for the parameter value domain string value for the parameter value principalname string name of the resource value mailaddress string value for the parameter value origin string value for the parameter value originid string unique identifier value displayname string name of the resource value links object value for the parameter value links self object value for the parameter value links self href string value for the parameter value links memberships object value for the parameter value links memberships href string value for the parameter value links membershipstate object value for the parameter value links membershipstate href string value for the parameter value links storagekey object value for the parameter value links storagekey href string value for the parameter value links avatar object value for the parameter value links avatar href string value for the parameter value url string url endpoint for the request value descriptor string value for the parameter output example {"count" 123,"value" \[{"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"}]} 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 path parameters organization string required parameters for the list pats action path parameters userdescriptor string required parameters for the list pats action parameters api version string required parameters for the list pats action parameters continuationtoken string optional parameters for the list pats action parameters ispublic boolean optional parameters for the list pats action parameters pagesize number optional parameters for the list pats action input example {"path parameters" {"organization" "swimlane test","userdescriptor" "msa ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} output parameter type description status code number http status code of the response reason string response reason phrase value array value for the parameter value clientid string unique identifier value accessid string unique identifier value authorizationid string unique identifier value hostauthorizationid string unique identifier value userid string unique identifier value validfrom string unique identifier value validto string unique identifier value displayname string name of the resource value scope string value for the parameter value targetaccounts array value for the parameter value token object value for the parameter value alternatetoken object value for the parameter value isvalid boolean unique identifier value ispublic boolean value for the parameter value publicdata object response data value source object value for the parameter value claims object value for the parameter continuationtoken object output field continuationtoken output example {"value" \[{"clientid" "string","accessid" "string","authorizationid" "string","hostauthorizationid" "string","userid" "string","validfrom" "string","validto" "string","displayname" "example name","scope" "string","targetaccounts" \[],"token" {},"alternatetoken" {},"isvalid"\ true,"ispublic"\ true,"publicdata" {}}],"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 path parameters organization string required parameters for the revoke pats action parameters api version string required parameters for the revoke pats action parameters ispublic boolean optional parameters for the revoke pats action input example {"parameters" {"api version" "7 1 preview\ 1","ispublic"\ false},"json body" \[{"authorizationid" "532c7fe6 74f8 408b 8051 4abb73dca491"}],"path parameters" {"organization" "swimlane test"}} 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 output example {"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 11d652c5 3fd5 4db7 a716 be5e3c4129f5 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 1043 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 19 33 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 8fea6f0ca3c847df82451af744bb8cd3 ref b bom02edge0715 ref c 2023 11 08t07 26 20z x tfs processid http response header x tfs processid c031a33a df9e 4fe9 83dd 6d9bb2d000d4 x tfs session http response header x tfs session 11d652c5 3fd5 4db7 a716 be5e3c4129f5 x vss e2eid http response header x vss e2eid 0e5a0902 6357 4e49 a012 4b020e217769 x vss senderdeploymentid http response header x vss senderdeploymentid 0444d719 954b 4970 8216 09ea10adddc8 x vss userdata http response header x vss userdata e9b6a93c 5610 69d2 88fc 52ad16e266d0 \ nick mailto allen\@swimlane com