Skip to content

Latest commit

 

History

History
561 lines (339 loc) · 17.8 KB

GroupApi.md

File metadata and controls

561 lines (339 loc) · 17.8 KB
Raw

\GroupApi

All URIs are relative to https://teamcity.jetbrains.com

Method HTTP request Description
AddGroup Post /app/rest/userGroups Add a new user group.
AddRoleAtScopeToGroup Post /app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope} Add a role with the specific scope to the matching user group.
AddRoleToGroup Post /app/rest/userGroups/{groupLocator}/roles Add a role to the matching user group.
DeleteGroup Delete /app/rest/userGroups/{groupLocator} Delete user group matching the locator.
GetAllGroups Get /app/rest/userGroups Get all user groups.
GetGroupParentGroups Get /app/rest/userGroups/{groupLocator}/parent-groups Get parent groups of the matching user group.
GetGroupProperties Get /app/rest/userGroups/{groupLocator}/properties Get properties of the matching user group.
GetGroupProperty Get /app/rest/userGroups/{groupLocator}/properties/{name} Get a property of the matching user group.
GetGroupRoleAtScope Get /app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope} Get a role with the specific scope of the matching user group.
GetGroupRoles Get /app/rest/userGroups/{groupLocator}/roles Get all roles of the matching user group.
GetUserGroupOfGroup Get /app/rest/userGroups/{groupLocator} Get user group matching the locator.
RemoveGroupProperty Delete /app/rest/userGroups/{groupLocator}/properties/{name} Remove a property of the matching user group.
RemoveRoleAtScopeFromGroup Delete /app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope} Remove a role with the specific scope from the matching user group.
SetGroupParentGroups Put /app/rest/userGroups/{groupLocator}/parent-groups Update parent groups of the matching user group.
SetGroupProperty Put /app/rest/userGroups/{groupLocator}/properties/{name} Update a property of the matching user group.
SetGroupRoles Put /app/rest/userGroups/{groupLocator}/roles Update roles of the matching user group.

AddGroup

Group AddGroup(ctx, optional) Add a new user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *AddGroupOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddGroupOpts struct

Name Type Description Notes
body optional.Interface of Group
fields optional.String

Return type

Group

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddRoleAtScopeToGroup

Role AddRoleAtScopeToGroup(ctx, groupLocator, roleId, scope) Add a role with the specific scope to the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
roleId string
scope string

Return type

Role

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddRoleToGroup

Role AddRoleToGroup(ctx, groupLocator, optional) Add a role to the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
optional *AddRoleToGroupOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddRoleToGroupOpts struct

Name Type Description Notes

body | optional.Interface of Role| |

Return type

Role

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteGroup

DeleteGroup(ctx, groupLocator) Delete user group matching the locator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllGroups

Groups GetAllGroups(ctx, optional) Get all user groups.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllGroupsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllGroupsOpts struct

Name Type Description Notes
fields optional.String

Return type

Groups

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupParentGroups

Groups GetGroupParentGroups(ctx, groupLocator, optional) Get parent groups of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
optional *GetGroupParentGroupsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetGroupParentGroupsOpts struct

Name Type Description Notes

fields | optional.String| |

Return type

Groups

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupProperties

Properties GetGroupProperties(ctx, groupLocator, optional) Get properties of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
optional *GetGroupPropertiesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetGroupPropertiesOpts struct

Name Type Description Notes

fields | optional.String| |

Return type

Properties

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupProperty

string GetGroupProperty(ctx, groupLocator, name) Get a property of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
name string

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupRoleAtScope

Role GetGroupRoleAtScope(ctx, groupLocator, roleId, scope) Get a role with the specific scope of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
roleId string
scope string

Return type

Role

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupRoles

Roles GetGroupRoles(ctx, groupLocator) Get all roles of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string

Return type

Roles

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserGroupOfGroup

Group GetUserGroupOfGroup(ctx, groupLocator, optional) Get user group matching the locator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
optional *GetUserGroupOfGroupOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetUserGroupOfGroupOpts struct

Name Type Description Notes

fields | optional.String| |

Return type

Group

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveGroupProperty

RemoveGroupProperty(ctx, groupLocator, name) Remove a property of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
name string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveRoleAtScopeFromGroup

RemoveRoleAtScopeFromGroup(ctx, groupLocator, roleId, scope) Remove a role with the specific scope from the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
roleId string
scope string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetGroupParentGroups

Groups SetGroupParentGroups(ctx, groupLocator, optional) Update parent groups of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
optional *SetGroupParentGroupsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetGroupParentGroupsOpts struct

Name Type Description Notes

body | optional.Interface of Groups| | fields | optional.String| |

Return type

Groups

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetGroupProperty

string SetGroupProperty(ctx, groupLocator, name, optional) Update a property of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
name string
optional *SetGroupPropertyOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetGroupPropertyOpts struct

Name Type Description Notes

body | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: text/plain
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetGroupRoles

Roles SetGroupRoles(ctx, groupLocator, optional) Update roles of the matching user group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupLocator string
optional *SetGroupRolesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetGroupRolesOpts struct

Name Type Description Notes

body | optional.Interface of Roles| |

Return type

Roles

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]