|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IIdentityManagementService
Method Summary | |
---|---|
void |
addMemberToApplicationGroup(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
Add member to TFS Group. |
IdentityDescriptor |
createApplicationGroup(java.lang.String projectUri,
java.lang.String groupName,
java.lang.String groupDescription)
Creates a TFS application group |
void |
deleteApplicationGroup(IdentityDescriptor groupDescriptor)
Deletes a TFS application group |
java.lang.String |
getIdentityDomainScope()
|
java.lang.String |
getScopeName(java.lang.String scopeId)
Gets the scope name for the provided scope id. |
boolean |
isMember(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
Expanded membership query for direct or nested member. |
boolean |
isOwnedWellKnownGroup(IdentityDescriptor descriptor)
Check if the given descriptor is of TeamFoundation type, belongs to this IMS host and is a well-known group. |
boolean |
isOwner(IdentityDescriptor descriptor)
Check if the given descriptor is of TeamFoundation type, and belongs to this IMS host. |
TeamFoundationIdentity[] |
listApplicationGroups(java.lang.String projectUri,
ReadIdentityOptions readOptions)
Lists all TFS application groups within the specified scope |
TeamFoundationIdentity[] |
readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds,
MembershipQuery queryMembership)
Read identities by Team Foundation Id. |
TeamFoundationIdentity[] |
readIdentities(IdentityDescriptor[] descriptors,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Read identities for given descriptors. |
TeamFoundationIdentity[][] |
readIdentities(IdentitySearchFactor searchFactor,
java.lang.String[] searchFactorValues,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Read identities based on search factor. |
TeamFoundationIdentity |
readIdentity(IdentityDescriptor descriptor,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Overload that takes a single descriptor. |
TeamFoundationIdentity |
readIdentity(IdentitySearchFactor searchFactor,
java.lang.String searchFactorValue,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Overload that takes a single search factor and returns match following this order. |
boolean |
refreshIdentity(IdentityDescriptor descriptor)
Refresh identity properties from provider now. |
void |
removeMemberFromApplicationGroup(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
Remove member from TFS Group. |
void |
updateApplicationGroup(IdentityDescriptor groupDescriptor,
GroupProperty groupProperty,
java.lang.String newValue)
Updates a property of a TFS application group |
Method Detail |
---|
TeamFoundationIdentity[] readIdentities(IdentityDescriptor[] descriptors, MembershipQuery queryMembership, ReadIdentityOptions readOptions)
descriptors
- descriptors (descriptor is identity type + identifier)queryMembership
- none, direct or expanded membership informationreadOptions
- read options, such as reading from source
TeamFoundationIdentity readIdentity(IdentityDescriptor descriptor, MembershipQuery queryMembership, ReadIdentityOptions readOptions)
descriptor
- identity type + identifierqueryMembership
- none, direct or expanded membership informationreadOptions
- read options, such as reading from source
TeamFoundationIdentity[] readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds, MembershipQuery queryMembership)
teamFoundationIds
- identity idsqueryMembership
- none, direct or expanded membership information
TeamFoundationIdentity[][] readIdentities(IdentitySearchFactor searchFactor, java.lang.String[] searchFactorValues, MembershipQuery queryMembership, ReadIdentityOptions readOptions)
searchFactor
- how search is specified (by account name, etc.)searchFactorValues
- actual search strings (account names, etc.)queryMembership
- none, direct or expanded membership informationreadOptions
- readOptions, such as reading from source
TeamFoundationIdentity readIdentity(IdentitySearchFactor searchFactor, java.lang.String searchFactorValue, MembershipQuery queryMembership, ReadIdentityOptions readOptions)
searchFactor
- how search is specified (by account name, etc.)searchFactorValue
- actual search string (account name, etc.)queryMembership
- none, direct or expanded membership informationreadOptions
- readOptions, such as reading from source
IdentityDescriptor createApplicationGroup(java.lang.String projectUri, java.lang.String groupName, java.lang.String groupDescription)
projectUri
- Scope Uri, specifying whether group scope is project level or
global to this host. Null or empty value signifies global scopegroupName
- namegroupDescription
- description. can be null
TeamFoundationIdentity[] listApplicationGroups(java.lang.String projectUri, ReadIdentityOptions readOptions)
projectUri
- Scope Uri, specifying whether group scope is project level or
global to this host. Null or empty value signifies global scopereadOptions
- read options
void updateApplicationGroup(IdentityDescriptor groupDescriptor, GroupProperty groupProperty, java.lang.String newValue)
groupDescriptor
- groupProperty
- which property to updatenewValue
- the new value for the propertyvoid deleteApplicationGroup(IdentityDescriptor groupDescriptor)
groupDescriptor
- groupDescriptorvoid addMemberToApplicationGroup(IdentityDescriptor groupDescriptor, IdentityDescriptor descriptor)
groupDescriptor
- groupDescriptordescriptor
- membervoid removeMemberFromApplicationGroup(IdentityDescriptor groupDescriptor, IdentityDescriptor descriptor)
groupDescriptor
- groupDescriptordescriptor
- memberboolean isMember(IdentityDescriptor groupDescriptor, IdentityDescriptor descriptor)
groupDescriptor
- groupdescriptor
- memberboolean refreshIdentity(IdentityDescriptor descriptor)
Identity properties, such as display name, are synced from the provider over a 24h cylce, by default. Use this API to sync now.
descriptor
- identity specification. Null implies caller
java.lang.String getScopeName(java.lang.String scopeId)
scopeId
- scope id, which is the project or domain Uri
boolean isOwner(IdentityDescriptor descriptor)
descriptor
-
boolean isOwnedWellKnownGroup(IdentityDescriptor descriptor)
descriptor
-
java.lang.String getIdentityDomainScope()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |