azure-devops/azext_devops/devops_sdk/v6_0/identity/models.py (335 lines of code) (raw):

# -------------------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class AccessTokenResult(Model): """ :param access_token: :type access_token: :class:`JsonWebToken <azure.devops.v6_0.microsoft._visual_studio._services._web_api.models.JsonWebToken>` :param access_token_error: :type access_token_error: object :param authorization_id: :type authorization_id: str :param error_description: :type error_description: str :param has_error: :type has_error: bool :param is_first_party_client: :type is_first_party_client: bool :param refresh_token: :type refresh_token: :class:`RefreshTokenGrant <azure.devops.v6_0.microsoft._visual_studio._services._web_api.models.RefreshTokenGrant>` :param scope: :type scope: str :param token_type: :type token_type: str :param valid_to: :type valid_to: datetime """ _attribute_map = { 'access_token': {'key': 'accessToken', 'type': 'JsonWebToken'}, 'access_token_error': {'key': 'accessTokenError', 'type': 'object'}, 'authorization_id': {'key': 'authorizationId', 'type': 'str'}, 'error_description': {'key': 'errorDescription', 'type': 'str'}, 'has_error': {'key': 'hasError', 'type': 'bool'}, 'is_first_party_client': {'key': 'isFirstPartyClient', 'type': 'bool'}, 'refresh_token': {'key': 'refreshToken', 'type': 'RefreshTokenGrant'}, 'scope': {'key': 'scope', 'type': 'str'}, 'token_type': {'key': 'tokenType', 'type': 'str'}, 'valid_to': {'key': 'validTo', 'type': 'iso-8601'} } def __init__(self, access_token=None, access_token_error=None, authorization_id=None, error_description=None, has_error=None, is_first_party_client=None, refresh_token=None, scope=None, token_type=None, valid_to=None): super(AccessTokenResult, self).__init__() self.access_token = access_token self.access_token_error = access_token_error self.authorization_id = authorization_id self.error_description = error_description self.has_error = has_error self.is_first_party_client = is_first_party_client self.refresh_token = refresh_token self.scope = scope self.token_type = token_type self.valid_to = valid_to class AuthorizationGrant(Model): """ :param grant_type: :type grant_type: object """ _attribute_map = { 'grant_type': {'key': 'grantType', 'type': 'object'} } def __init__(self, grant_type=None): super(AuthorizationGrant, self).__init__() self.grant_type = grant_type class ChangedIdentities(Model): """ Container class for changed identities :param identities: Changed Identities :type identities: list of :class:`Identity <azure.devops.v6_0.identities.models.Identity>` :param more_data: More data available, set to true if pagesize is specified. :type more_data: bool :param sequence_context: Last Identity SequenceId :type sequence_context: :class:`ChangedIdentitiesContext <azure.devops.v6_0.identities.models.ChangedIdentitiesContext>` """ _attribute_map = { 'identities': {'key': 'identities', 'type': '[Identity]'}, 'more_data': {'key': 'moreData', 'type': 'bool'}, 'sequence_context': {'key': 'sequenceContext', 'type': 'ChangedIdentitiesContext'} } def __init__(self, identities=None, more_data=None, sequence_context=None): super(ChangedIdentities, self).__init__() self.identities = identities self.more_data = more_data self.sequence_context = sequence_context class ChangedIdentitiesContext(Model): """ Context class for changed identities :param group_sequence_id: Last Group SequenceId :type group_sequence_id: int :param identity_sequence_id: Last Identity SequenceId :type identity_sequence_id: int :param organization_identity_sequence_id: Last Group OrganizationIdentitySequenceId :type organization_identity_sequence_id: int :param page_size: Page size :type page_size: int """ _attribute_map = { 'group_sequence_id': {'key': 'groupSequenceId', 'type': 'int'}, 'identity_sequence_id': {'key': 'identitySequenceId', 'type': 'int'}, 'organization_identity_sequence_id': {'key': 'organizationIdentitySequenceId', 'type': 'int'}, 'page_size': {'key': 'pageSize', 'type': 'int'} } def __init__(self, group_sequence_id=None, identity_sequence_id=None, organization_identity_sequence_id=None, page_size=None): super(ChangedIdentitiesContext, self).__init__() self.group_sequence_id = group_sequence_id self.identity_sequence_id = identity_sequence_id self.organization_identity_sequence_id = organization_identity_sequence_id self.page_size = page_size class CreateScopeInfo(Model): """ :param admin_group_description: :type admin_group_description: str :param admin_group_name: :type admin_group_name: str :param creator_id: :type creator_id: str :param parent_scope_id: :type parent_scope_id: str :param scope_name: :type scope_name: str :param scope_type: :type scope_type: object """ _attribute_map = { 'admin_group_description': {'key': 'adminGroupDescription', 'type': 'str'}, 'admin_group_name': {'key': 'adminGroupName', 'type': 'str'}, 'creator_id': {'key': 'creatorId', 'type': 'str'}, 'parent_scope_id': {'key': 'parentScopeId', 'type': 'str'}, 'scope_name': {'key': 'scopeName', 'type': 'str'}, 'scope_type': {'key': 'scopeType', 'type': 'object'} } def __init__(self, admin_group_description=None, admin_group_name=None, creator_id=None, parent_scope_id=None, scope_name=None, scope_type=None): super(CreateScopeInfo, self).__init__() self.admin_group_description = admin_group_description self.admin_group_name = admin_group_name self.creator_id = creator_id self.parent_scope_id = parent_scope_id self.scope_name = scope_name self.scope_type = scope_type class FrameworkIdentityInfo(Model): """ :param display_name: :type display_name: str :param identifier: :type identifier: str :param identity_type: :type identity_type: object :param role: :type role: str """ _attribute_map = { 'display_name': {'key': 'displayName', 'type': 'str'}, 'identifier': {'key': 'identifier', 'type': 'str'}, 'identity_type': {'key': 'identityType', 'type': 'object'}, 'role': {'key': 'role', 'type': 'str'} } def __init__(self, display_name=None, identifier=None, identity_type=None, role=None): super(FrameworkIdentityInfo, self).__init__() self.display_name = display_name self.identifier = identifier self.identity_type = identity_type self.role = role class GroupMembership(Model): """ :param active: :type active: bool :param descriptor: :type descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param id: :type id: str :param queried_id: :type queried_id: str """ _attribute_map = { 'active': {'key': 'active', 'type': 'bool'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'queried_id': {'key': 'queriedId', 'type': 'str'} } def __init__(self, active=None, descriptor=None, id=None, queried_id=None): super(GroupMembership, self).__init__() self.active = active self.descriptor = descriptor self.id = id self.queried_id = queried_id class IdentityBase(Model): """ Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str :param descriptor: :type descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param id: Identity Identifier. Also called Storage Key, or VSID :type id: str :param is_active: True if the identity has a membership in any Azure Devops group in the organization. :type is_active: bool :param is_container: True if the identity is a group. :type is_container: bool :param master_id: :type master_id: str :param member_ids: Id of the members of the identity (groups only). :type member_ids: list of str :param member_of: :type member_of: list of :class:`str <azure.devops.v6_0.identities.models.str>` :param members: :type members: list of :class:`str <azure.devops.v6_0.identities.models.str>` :param meta_type_id: :type meta_type_id: int :param properties: :type properties: :class:`object <azure.devops.v6_0.identities.models.object>` :param provider_display_name: The display name for the identity as specified by the source identity provider. :type provider_display_name: str :param resource_version: :type resource_version: int :param social_descriptor: :type social_descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param subject_descriptor: Subject descriptor of a Graph entity. :type subject_descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param unique_user_id: :type unique_user_id: int """ _attribute_map = { 'custom_display_name': {'key': 'customDisplayName', 'type': 'str'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_active': {'key': 'isActive', 'type': 'bool'}, 'is_container': {'key': 'isContainer', 'type': 'bool'}, 'master_id': {'key': 'masterId', 'type': 'str'}, 'member_ids': {'key': 'memberIds', 'type': '[str]'}, 'member_of': {'key': 'memberOf', 'type': '[str]'}, 'members': {'key': 'members', 'type': '[str]'}, 'meta_type_id': {'key': 'metaTypeId', 'type': 'int'}, 'properties': {'key': 'properties', 'type': 'object'}, 'provider_display_name': {'key': 'providerDisplayName', 'type': 'str'}, 'resource_version': {'key': 'resourceVersion', 'type': 'int'}, 'social_descriptor': {'key': 'socialDescriptor', 'type': 'str'}, 'subject_descriptor': {'key': 'subjectDescriptor', 'type': 'str'}, 'unique_user_id': {'key': 'uniqueUserId', 'type': 'int'} } def __init__(self, custom_display_name=None, descriptor=None, id=None, is_active=None, is_container=None, master_id=None, member_ids=None, member_of=None, members=None, meta_type_id=None, properties=None, provider_display_name=None, resource_version=None, social_descriptor=None, subject_descriptor=None, unique_user_id=None): super(IdentityBase, self).__init__() self.custom_display_name = custom_display_name self.descriptor = descriptor self.id = id self.is_active = is_active self.is_container = is_container self.master_id = master_id self.member_ids = member_ids self.member_of = member_of self.members = members self.meta_type_id = meta_type_id self.properties = properties self.provider_display_name = provider_display_name self.resource_version = resource_version self.social_descriptor = social_descriptor self.subject_descriptor = subject_descriptor self.unique_user_id = unique_user_id class IdentityBatchInfo(Model): """ :param descriptors: :type descriptors: list of :class:`str <azure.devops.v6_0.identities.models.str>` :param identity_ids: :type identity_ids: list of str :param include_restricted_visibility: :type include_restricted_visibility: bool :param property_names: :type property_names: list of str :param query_membership: :type query_membership: object :param social_descriptors: :type social_descriptors: list of :class:`str <azure.devops.v6_0.identities.models.str>` :param subject_descriptors: :type subject_descriptors: list of :class:`str <azure.devops.v6_0.identities.models.str>` """ _attribute_map = { 'descriptors': {'key': 'descriptors', 'type': '[str]'}, 'identity_ids': {'key': 'identityIds', 'type': '[str]'}, 'include_restricted_visibility': {'key': 'includeRestrictedVisibility', 'type': 'bool'}, 'property_names': {'key': 'propertyNames', 'type': '[str]'}, 'query_membership': {'key': 'queryMembership', 'type': 'object'}, 'social_descriptors': {'key': 'socialDescriptors', 'type': '[str]'}, 'subject_descriptors': {'key': 'subjectDescriptors', 'type': '[str]'} } def __init__(self, descriptors=None, identity_ids=None, include_restricted_visibility=None, property_names=None, query_membership=None, social_descriptors=None, subject_descriptors=None): super(IdentityBatchInfo, self).__init__() self.descriptors = descriptors self.identity_ids = identity_ids self.include_restricted_visibility = include_restricted_visibility self.property_names = property_names self.query_membership = query_membership self.social_descriptors = social_descriptors self.subject_descriptors = subject_descriptors class IdentityRightsTransferData(Model): """ :param user_principal_name_mappings: :type user_principal_name_mappings: dict """ _attribute_map = { 'user_principal_name_mappings': {'key': 'userPrincipalNameMappings', 'type': '{str}'} } def __init__(self, user_principal_name_mappings=None): super(IdentityRightsTransferData, self).__init__() self.user_principal_name_mappings = user_principal_name_mappings class IdentityScope(Model): """ :param administrators: :type administrators: :class:`str <azure.devops.v6_0.identities.models.str>` :param id: :type id: str :param is_active: :type is_active: bool :param is_global: :type is_global: bool :param local_scope_id: :type local_scope_id: str :param name: :type name: str :param parent_id: :type parent_id: str :param scope_type: :type scope_type: object :param securing_host_id: :type securing_host_id: str :param subject_descriptor: :type subject_descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` """ _attribute_map = { 'administrators': {'key': 'administrators', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_active': {'key': 'isActive', 'type': 'bool'}, 'is_global': {'key': 'isGlobal', 'type': 'bool'}, 'local_scope_id': {'key': 'localScopeId', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_id': {'key': 'parentId', 'type': 'str'}, 'scope_type': {'key': 'scopeType', 'type': 'object'}, 'securing_host_id': {'key': 'securingHostId', 'type': 'str'}, 'subject_descriptor': {'key': 'subjectDescriptor', 'type': 'str'} } def __init__(self, administrators=None, id=None, is_active=None, is_global=None, local_scope_id=None, name=None, parent_id=None, scope_type=None, securing_host_id=None, subject_descriptor=None): super(IdentityScope, self).__init__() self.administrators = administrators self.id = id self.is_active = is_active self.is_global = is_global self.local_scope_id = local_scope_id self.name = name self.parent_id = parent_id self.scope_type = scope_type self.securing_host_id = securing_host_id self.subject_descriptor = subject_descriptor class IdentitySelf(Model): """ Identity information. :param account_name: The UserPrincipalName (UPN) of the account. This value comes from the source provider. :type account_name: str :param display_name: The display name. For AAD accounts with multiple tenants this is the display name of the profile in the home tenant. :type display_name: str :param domain: This represents the name of the container of origin. For AAD accounts this is the tenantID of the home tenant. For MSA accounts this is the string "Windows Live ID". :type domain: str :param id: This is the VSID of the home tenant profile. If the profile is signed into the home tenant or if the profile has no tenants then this Id is the same as the Id returned by the profile/profiles/me endpoint. Going forward it is recommended that you use the combined values of Origin, OriginId and Domain to uniquely identify a user rather than this Id. :type id: str :param origin: The type of source provider for the origin identifier. For MSA accounts this is "msa". For AAD accounts this is "aad". :type origin: str :param origin_id: The unique identifier from the system of origin. If there are multiple tenants this is the unique identifier of the account in the home tenant. (For MSA this is the PUID in hex notation, for AAD this is the object id.) :type origin_id: str :param tenants: For AAD accounts this is all of the tenants that this account is a member of. :type tenants: list of :class:`TenantInfo <azure.devops.v6_0.identities.models.TenantInfo>` """ _attribute_map = { 'account_name': {'key': 'accountName', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'domain': {'key': 'domain', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'origin': {'key': 'origin', 'type': 'str'}, 'origin_id': {'key': 'originId', 'type': 'str'}, 'tenants': {'key': 'tenants', 'type': '[TenantInfo]'} } def __init__(self, account_name=None, display_name=None, domain=None, id=None, origin=None, origin_id=None, tenants=None): super(IdentitySelf, self).__init__() self.account_name = account_name self.display_name = display_name self.domain = domain self.id = id self.origin = origin self.origin_id = origin_id self.tenants = tenants class IdentitySnapshot(Model): """ :param groups: :type groups: list of :class:`Identity <azure.devops.v6_0.identities.models.Identity>` :param identity_ids: :type identity_ids: list of str :param memberships: :type memberships: list of :class:`GroupMembership <azure.devops.v6_0.identities.models.GroupMembership>` :param scope_id: :type scope_id: str :param scopes: :type scopes: list of :class:`IdentityScope <azure.devops.v6_0.identities.models.IdentityScope>` """ _attribute_map = { 'groups': {'key': 'groups', 'type': '[Identity]'}, 'identity_ids': {'key': 'identityIds', 'type': '[str]'}, 'memberships': {'key': 'memberships', 'type': '[GroupMembership]'}, 'scope_id': {'key': 'scopeId', 'type': 'str'}, 'scopes': {'key': 'scopes', 'type': '[IdentityScope]'} } def __init__(self, groups=None, identity_ids=None, memberships=None, scope_id=None, scopes=None): super(IdentitySnapshot, self).__init__() self.groups = groups self.identity_ids = identity_ids self.memberships = memberships self.scope_id = scope_id self.scopes = scopes class IdentityUpdateData(Model): """ :param id: :type id: str :param index: :type index: int :param updated: :type updated: bool """ _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'index': {'key': 'index', 'type': 'int'}, 'updated': {'key': 'updated', 'type': 'bool'} } def __init__(self, id=None, index=None, updated=None): super(IdentityUpdateData, self).__init__() self.id = id self.index = index self.updated = updated class JsonPatchOperation(Model): """ The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str :param op: The patch operation :type op: object :param path: The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-). :type path: str :param value: The value for the operation. This is either a primitive or a JToken. :type value: object """ _attribute_map = { 'from_': {'key': 'from', 'type': 'str'}, 'op': {'key': 'op', 'type': 'object'}, 'path': {'key': 'path', 'type': 'str'}, 'value': {'key': 'value', 'type': 'object'} } def __init__(self, from_=None, op=None, path=None, value=None): super(JsonPatchOperation, self).__init__() self.from_ = from_ self.op = op self.path = path self.value = value class JsonWebToken(Model): """ """ _attribute_map = { } def __init__(self): super(JsonWebToken, self).__init__() class PagedIdentities(Model): """ :param continuation_token: :type continuation_token: list of str :param identities: :type identities: list of :class:`Identity <azure.devops.v6_0.identities.models.Identity>` """ _attribute_map = { 'continuation_token': {'key': 'continuationToken', 'type': '[str]'}, 'identities': {'key': 'identities', 'type': '[Identity]'} } def __init__(self, continuation_token=None, identities=None): super(PagedIdentities, self).__init__() self.continuation_token = continuation_token self.identities = identities class RefreshTokenGrant(AuthorizationGrant): """ :param grant_type: :type grant_type: object :param jwt: :type jwt: :class:`JsonWebToken <azure.devops.v6_0.microsoft._visual_studio._services._web_api.models.JsonWebToken>` """ _attribute_map = { 'grant_type': {'key': 'grantType', 'type': 'object'}, 'jwt': {'key': 'jwt', 'type': 'JsonWebToken'} } def __init__(self, grant_type=None, jwt=None): super(RefreshTokenGrant, self).__init__(grant_type=grant_type) self.jwt = jwt class SwapIdentityInfo(Model): """ :param id1: :type id1: str :param id2: :type id2: str """ _attribute_map = { 'id1': {'key': 'id1', 'type': 'str'}, 'id2': {'key': 'id2', 'type': 'str'} } def __init__(self, id1=None, id2=None): super(SwapIdentityInfo, self).__init__() self.id1 = id1 self.id2 = id2 class TenantInfo(Model): """ :param home_tenant: :type home_tenant: bool :param tenant_id: :type tenant_id: str :param tenant_name: :type tenant_name: str :param verified_domains: :type verified_domains: list of str """ _attribute_map = { 'home_tenant': {'key': 'homeTenant', 'type': 'bool'}, 'tenant_id': {'key': 'tenantId', 'type': 'str'}, 'tenant_name': {'key': 'tenantName', 'type': 'str'}, 'verified_domains': {'key': 'verifiedDomains', 'type': '[str]'} } def __init__(self, home_tenant=None, tenant_id=None, tenant_name=None, verified_domains=None): super(TenantInfo, self).__init__() self.home_tenant = home_tenant self.tenant_id = tenant_id self.tenant_name = tenant_name self.verified_domains = verified_domains class Identity(IdentityBase): """ :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str :param descriptor: :type descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param id: Identity Identifier. Also called Storage Key, or VSID :type id: str :param is_active: True if the identity has a membership in any Azure Devops group in the organization. :type is_active: bool :param is_container: True if the identity is a group. :type is_container: bool :param master_id: :type master_id: str :param member_ids: Id of the members of the identity (groups only). :type member_ids: list of str :param member_of: :type member_of: list of :class:`str <azure.devops.v6_0.identities.models.str>` :param members: :type members: list of :class:`str <azure.devops.v6_0.identities.models.str>` :param meta_type_id: :type meta_type_id: int :param properties: :type properties: :class:`object <azure.devops.v6_0.identities.models.object>` :param provider_display_name: The display name for the identity as specified by the source identity provider. :type provider_display_name: str :param resource_version: :type resource_version: int :param social_descriptor: :type social_descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param subject_descriptor: Subject descriptor of a Graph entity. :type subject_descriptor: :class:`str <azure.devops.v6_0.identities.models.str>` :param unique_user_id: :type unique_user_id: int """ _attribute_map = { 'custom_display_name': {'key': 'customDisplayName', 'type': 'str'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_active': {'key': 'isActive', 'type': 'bool'}, 'is_container': {'key': 'isContainer', 'type': 'bool'}, 'master_id': {'key': 'masterId', 'type': 'str'}, 'member_ids': {'key': 'memberIds', 'type': '[str]'}, 'member_of': {'key': 'memberOf', 'type': '[str]'}, 'members': {'key': 'members', 'type': '[str]'}, 'meta_type_id': {'key': 'metaTypeId', 'type': 'int'}, 'properties': {'key': 'properties', 'type': 'object'}, 'provider_display_name': {'key': 'providerDisplayName', 'type': 'str'}, 'resource_version': {'key': 'resourceVersion', 'type': 'int'}, 'social_descriptor': {'key': 'socialDescriptor', 'type': 'str'}, 'subject_descriptor': {'key': 'subjectDescriptor', 'type': 'str'}, 'unique_user_id': {'key': 'uniqueUserId', 'type': 'int'}, } def __init__(self, custom_display_name=None, descriptor=None, id=None, is_active=None, is_container=None, master_id=None, member_ids=None, member_of=None, members=None, meta_type_id=None, properties=None, provider_display_name=None, resource_version=None, social_descriptor=None, subject_descriptor=None, unique_user_id=None): super(Identity, self).__init__(custom_display_name=custom_display_name, descriptor=descriptor, id=id, is_active=is_active, is_container=is_container, master_id=master_id, member_ids=member_ids, member_of=member_of, members=members, meta_type_id=meta_type_id, properties=properties, provider_display_name=provider_display_name, resource_version=resource_version, social_descriptor=social_descriptor, subject_descriptor=subject_descriptor, unique_user_id=unique_user_id) __all__ = [ 'AccessTokenResult', 'AuthorizationGrant', 'ChangedIdentities', 'ChangedIdentitiesContext', 'CreateScopeInfo', 'FrameworkIdentityInfo', 'GroupMembership', 'IdentityBase', 'IdentityBatchInfo', 'IdentityRightsTransferData', 'IdentityScope', 'IdentitySelf', 'IdentitySnapshot', 'IdentityUpdateData', 'JsonPatchOperation', 'JsonWebToken', 'PagedIdentities', 'RefreshTokenGrant', 'SwapIdentityInfo', 'TenantInfo', 'Identity', ]