Руководство пользователя HubEx

Краткие инcтрукции по работе, основные понятия и первые шаги по освоению платформы.

AUTHN — схемы

Что здесь: определения типов запросов/ответов сервиса AUTHN. Ручки, ссылающиеся на них — endpoints/AUTHN.md.

type AccountRealmResult { realm?: str, tenantID?: int, tenantName?: str }
type Assembly { codeBase?: str, customAttributes?: CustomAttributeData[], definedTypes?: TypeInfo[], entryPoint?: MethodInfo, escapedCodeBase?: str, exportedTypes?: Type[], fullName?: str, globalAssemblyCache?: bool, hostContext?: int, imageRuntimeVersion?: str, isCollectible?: bool, isDynamic?: bool, isFullyTrusted?: bool, location?: str, manifestModule?: Module, modules?: Module[], reflectionOnly?: bool, securityRuleSet?: SecurityRuleSet }
type AuthenticationResult { access_token?: str, accountHasUserProfile?: bool, accountUserTypeID?: int, expires_in?: int, isAnonymous?: bool, isCrossTenantAdmin?: bool, jwtValidTill?: datetime, refresh_token?: str, requests?: TenantCreationRequestEntity[], tenantEntities?: TenantAuthorizationProjection[] }
type AuthSmsDto { code?: str, phone?: str }
type CallingConventions enum(Standard, VarArgs, Any, HasThis, ExplicitThis)
type ConstructorInfo { attributes?: MethodAttributes, callingConvention?: CallingConventions, containsGenericParameters?: bool, customAttributes?: CustomAttributeData[], declaringType?: Type, isAbstract?: bool, isAssembly?: bool, isCollectible?: bool, isConstructedGenericMethod?: bool, isConstructor?: bool, isFamily?: bool, isFamilyAndAssembly?: bool, isFamilyOrAssembly?: bool, isFinal?: bool, isGenericMethod?: bool, isGenericMethodDefinition?: bool, isHideBySig?: bool, isPrivate?: bool, isPublic?: bool, isSecurityCritical?: bool, isSecuritySafeCritical?: bool, isSecurityTransparent?: bool, isSpecialName?: bool, isStatic?: bool, isVirtual?: bool, memberType?: MemberTypes, metadataToken?: int, methodHandle?: RuntimeMethodHandle, methodImplementationFlags?: MethodImplAttributes, module?: Module, name?: str, reflectedType?: Type }
type CredentialData { credential: str }
type CustomAttributeData { attributeType?: Type, constructor?: ConstructorInfo, constructorArguments?: CustomAttributeTypedArgument[], namedArguments?: CustomAttributeNamedArgument[] }
type CustomAttributeNamedArgument { isField?: bool, memberInfo?: MemberInfo, memberName?: str, typedValue?: CustomAttributeTypedArgument }
type CustomAttributeTypedArgument { argumentType?: Type, value?: any }
type ErrorModel { arguments?: map<str>, code?: str, message?: str, traceIdentifier?: str }
type EventAttributes enum(None, SpecialName, RTSpecialName)
type EventInfo { addMethod?: MethodInfo, attributes?: EventAttributes, customAttributes?: CustomAttributeData[], declaringType?: Type, eventHandlerType?: Type, isCollectible?: bool, isMulticast?: bool, isSpecialName?: bool, memberType?: MemberTypes, metadataToken?: int, module?: Module, name?: str, raiseMethod?: MethodInfo, reflectedType?: Type, removeMethod?: MethodInfo }
type FieldAttributes enum(PrivateScope, Private, FamANDAssem, Assembly, Family, FamORAssem, Public, FieldAccessMask, Static, InitOnly, Literal, NotSerialized, HasFieldRVA, SpecialName, RTSpecialName, HasFieldMarshal, PinvokeImpl, HasDefault, ReservedMask)
type FieldInfo { attributes?: FieldAttributes, customAttributes?: CustomAttributeData[], declaringType?: Type, fieldHandle?: RuntimeFieldHandle, fieldType?: Type, isAssembly?: bool, isCollectible?: bool, isFamily?: bool, isFamilyAndAssembly?: bool, isFamilyOrAssembly?: bool, isInitOnly?: bool, isLiteral?: bool, isNotSerialized?: bool, isPinvokeImpl?: bool, isPrivate?: bool, isPublic?: bool, isSecurityCritical?: bool, isSecuritySafeCritical?: bool, isSecurityTransparent?: bool, isSpecialName?: bool, isStatic?: bool, memberType?: MemberTypes, metadataToken?: int, module?: Module, name?: str, reflectedType?: Type }
type GenericParameterAttributes enum(None, Covariant, Contravariant, VarianceMask, ReferenceTypeConstraint, NotNullableValueTypeConstraint, DefaultConstructorConstraint, SpecialConstraintMask)
type ICustomAttributeProvider map
type IntPtr map
type IOutputFormatter map
type JwtResultBase { access_token?: str, accountUserTypeID?: int, expires_in?: int, jwtValidTill?: datetime, refresh_token?: str }
type LayoutKind enum(Sequential, Explicit, Auto)
type MemberInfo { customAttributes?: CustomAttributeData[], declaringType?: Type, isCollectible?: bool, memberType?: MemberTypes, metadataToken?: int, module?: Module, name?: str, reflectedType?: Type }
type MemberTypes enum(Constructor, Event, Field, Method, Property, TypeInfo, Custom, NestedType, All)
type MethodAttributes enum(PrivateScope, Private, FamANDAssem, Assembly, Family, FamORAssem, Public, MemberAccessMask, UnmanagedExport, Static, Final, Virtual, HideBySig, NewSlot, CheckAccessOnOverride, Abstract, SpecialName, RTSpecialName, PinvokeImpl, HasSecurity, RequireSecObject, ReservedMask)
type MethodBase { attributes?: MethodAttributes, callingConvention?: CallingConventions, containsGenericParameters?: bool, customAttributes?: CustomAttributeData[], declaringType?: Type, isAbstract?: bool, isAssembly?: bool, isCollectible?: bool, isConstructedGenericMethod?: bool, isConstructor?: bool, isFamily?: bool, isFamilyAndAssembly?: bool, isFamilyOrAssembly?: bool, isFinal?: bool, isGenericMethod?: bool, isGenericMethodDefinition?: bool, isHideBySig?: bool, isPrivate?: bool, isPublic?: bool, isSecurityCritical?: bool, isSecuritySafeCritical?: bool, isSecurityTransparent?: bool, isSpecialName?: bool, isStatic?: bool, isVirtual?: bool, memberType?: MemberTypes, metadataToken?: int, methodHandle?: RuntimeMethodHandle, methodImplementationFlags?: MethodImplAttributes, module?: Module, name?: str, reflectedType?: Type }
type MethodImplAttributes enum(IL, Native, OPTIL, CodeTypeMask, ManagedMask, NoInlining, ForwardRef, Synchronized, NoOptimization, PreserveSig, AggressiveInlining, AggressiveOptimization, InternalCall, MaxMethodImplVal)
type MethodInfo { attributes?: MethodAttributes, callingConvention?: CallingConventions, containsGenericParameters?: bool, customAttributes?: CustomAttributeData[], declaringType?: Type, isAbstract?: bool, isAssembly?: bool, isCollectible?: bool, isConstructedGenericMethod?: bool, isConstructor?: bool, isFamily?: bool, isFamilyAndAssembly?: bool, isFamilyOrAssembly?: bool, isFinal?: bool, isGenericMethod?: bool, isGenericMethodDefinition?: bool, isHideBySig?: bool, isPrivate?: bool, isPublic?: bool, isSecurityCritical?: bool, isSecuritySafeCritical?: bool, isSecurityTransparent?: bool, isSpecialName?: bool, isStatic?: bool, isVirtual?: bool, memberType?: MemberTypes, metadataToken?: int, methodHandle?: RuntimeMethodHandle, methodImplementationFlags?: MethodImplAttributes, module?: Module, name?: str, reflectedType?: Type, returnParameter?: ParameterInfo, returnType?: Type, returnTypeCustomAttributes?: ICustomAttributeProvider }
type Module { assembly?: Assembly, customAttributes?: CustomAttributeData[], fullyQualifiedName?: str, mdStreamVersion?: int, metadataToken?: int, moduleHandle?: ModuleHandle, moduleVersionId?: uuid, name?: str, scopeName?: str }
type ModuleHandle { mdStreamVersion?: int }
type ObjectResult { contentTypes?: str[], declaredType?: Type, formatters?: IOutputFormatter[], statusCode?: int, value?: any }
type OtpGenerateResult { phone?: str }
type ParameterAttributes enum(None, In, Out, Lcid, Retval, Optional, HasDefault, HasFieldMarshal, Reserved3, Reserved4, ReservedMask)
type ParameterInfo { attributes?: ParameterAttributes, customAttributes?: CustomAttributeData[], defaultValue?: any, hasDefaultValue?: bool, isIn?: bool, isLcid?: bool, isOptional?: bool, isOut?: bool, isRetval?: bool, member?: MemberInfo, metadataToken?: int, name?: str, parameterType?: Type, position?: int, rawDefaultValue?: any }
type PhoneDto { phone?: str }
type PropertyAttributes enum(None, SpecialName, RTSpecialName, HasDefault, Reserved2, Reserved3, Reserved4, ReservedMask)
type PropertyInfo { attributes?: PropertyAttributes, canRead?: bool, canWrite?: bool, customAttributes?: CustomAttributeData[], declaringType?: Type, getMethod?: MethodInfo, isCollectible?: bool, isSpecialName?: bool, memberType?: MemberTypes, metadataToken?: int, module?: Module, name?: str, propertyType?: Type, reflectedType?: Type, setMethod?: MethodInfo }
type RuntimeFieldHandle { value?: IntPtr }
type RuntimeMethodHandle { value?: IntPtr }
type RuntimeTypeHandle { value?: IntPtr }
type SecurityRuleSet enum(None, Level1, Level2)
type SetData { code?: str, codeHash?: str, mobilePhone?: str, password: str }
type StructLayoutAttribute { typeId?: any, value?: LayoutKind }
type TenantAuthorizationProjection { accountID?: int, banReasonCode?: str, banReasonID?: int, banTill?: datetime, email?: str, firstName?: str, fullName?: str, hasUserProfile?: bool, isTenantArchived?: bool, isTenantDeleted?: bool, isUserBanned?: bool, lastName?: str, middleName?: str, name?: str, tenantID?: int, tenantMemberDescription?: str, tenantMemberID?: int, tenantMemberValidTill?: datetime, uriName?: str, userBanReasonCode?: str, userBanReasonID?: int, userBanTill?: datetime, userID?: int }
type TenantCreationRequestEntity { accountID?: int, approved?: datetime, created?: datetime, id?: str, isSuccess?: bool, licenseID?: int, message?: str, ownerFirstName?: str, ownerLastName?: str, ownerMiddleName?: str, processed?: datetime, rejected?: datetime, rejectionReason?: str, templateID?: int, tenantFullName?: str, tenantID?: int, tenantName?: str, tenantUriName?: str }
type Type { assembly?: Assembly, assemblyQualifiedName?: str, attributes?: TypeAttributes, baseType?: Type, containsGenericParameters?: bool, customAttributes?: CustomAttributeData[], declaringMethod?: MethodBase, declaringType?: Type, fullName?: str, genericParameterAttributes?: GenericParameterAttributes, genericParameterPosition?: int, genericTypeArguments?: Type[], guid?: uuid, hasElementType?: bool, isAbstract?: bool, isAnsiClass?: bool, isArray?: bool, isAutoClass?: bool, isAutoLayout?: bool, isByRef?: bool, isByRefLike?: bool, isCOMObject?: bool, isClass?: bool, isCollectible?: bool, isConstructedGenericType?: bool, isContextful?: bool, isEnum?: bool, isExplicitLayout?: bool, isFunctionPointer?: bool, isGenericMethodParameter?: bool, isGenericParameter?: bool, isGenericType?: bool, isGenericTypeDefinition?: bool, isGenericTypeParameter?: bool, isImport?: bool, isInterface?: bool, isLayoutSequential?: bool, isMarshalByRef?: bool, isNested?: bool, isNestedAssembly?: bool, isNestedFamANDAssem?: bool, isNestedFamORAssem?: bool, isNestedFamily?: bool, isNestedPrivate?: bool, isNestedPublic?: bool, isNotPublic?: bool, isPointer?: bool, isPrimitive?: bool, isPublic?: bool, isSZArray?: bool, isSealed?: bool, isSecurityCritical?: bool, isSecuritySafeCritical?: bool, isSecurityTransparent?: bool, isSerializable?: bool, isSignatureType?: bool, isSpecialName?: bool, isTypeDefinition?: bool, isUnicodeClass?: bool, isUnmanagedFunctionPointer?: bool, isValueType?: bool, isVariableBoundArray?: bool, isVisible?: bool, memberType?: MemberTypes, metadataToken?: int, module?: Module, name?: str, namespace?: str, reflectedType?: Type, structLayoutAttribute?: StructLayoutAttribute, typeHandle?: RuntimeTypeHandle, typeInitializer?: ConstructorInfo, underlyingSystemType?: Type }
type TypeAttributes enum(NotPublic, Public, NestedPublic, NestedPrivate, NestedFamily, NestedAssembly, NestedFamANDAssem, VisibilityMask, SequentialLayout, ExplicitLayout, LayoutMask, Interface, Abstract, Sealed, SpecialName, RTSpecialName, Import, Serializable, WindowsRuntime, UnicodeClass, AutoClass, StringFormatMask, HasSecurity, ReservedMask, BeforeFieldInit, CustomFormatMask)
type TypeInfo { assembly?: Assembly, assemblyQualifiedName?: str, attributes?: TypeAttributes, baseType?: Type, containsGenericParameters?: bool, customAttributes?: CustomAttributeData[], declaredConstructors?: ConstructorInfo[], declaredEvents?: EventInfo[], declaredFields?: FieldInfo[], declaredMembers?: MemberInfo[], declaredMethods?: MethodInfo[], declaredNestedTypes?: TypeInfo[], declaredProperties?: PropertyInfo[], declaringMethod?: MethodBase, declaringType?: Type, fullName?: str, genericParameterAttributes?: GenericParameterAttributes, genericParameterPosition?: int, genericTypeArguments?: Type[], genericTypeParameters?: Type[], guid?: uuid, hasElementType?: bool, implementedInterfaces?: Type[], isAbstract?: bool, isAnsiClass?: bool, isArray?: bool, isAutoClass?: bool, isAutoLayout?: bool, isByRef?: bool, isByRefLike?: bool, isCOMObject?: bool, isClass?: bool, isCollectible?: bool, isConstructedGenericType?: bool, isContextful?: bool, isEnum?: bool, isExplicitLayout?: bool, isFunctionPointer?: bool, isGenericMethodParameter?: bool, isGenericParameter?: bool, isGenericType?: bool, isGenericTypeDefinition?: bool, isGenericTypeParameter?: bool, isImport?: bool, isInterface?: bool, isLayoutSequential?: bool, isMarshalByRef?: bool, isNested?: bool, isNestedAssembly?: bool, isNestedFamANDAssem?: bool, isNestedFamORAssem?: bool, isNestedFamily?: bool, isNestedPrivate?: bool, isNestedPublic?: bool, isNotPublic?: bool, isPointer?: bool, isPrimitive?: bool, isPublic?: bool, isSZArray?: bool, isSealed?: bool, isSecurityCritical?: bool, isSecuritySafeCritical?: bool, isSecurityTransparent?: bool, isSerializable?: bool, isSignatureType?: bool, isSpecialName?: bool, isTypeDefinition?: bool, isUnicodeClass?: bool, isUnmanagedFunctionPointer?: bool, isValueType?: bool, isVariableBoundArray?: bool, isVisible?: bool, memberType?: MemberTypes, metadataToken?: int, module?: Module, name?: str, namespace?: str, reflectedType?: Type, structLayoutAttribute?: StructLayoutAttribute, typeHandle?: RuntimeTypeHandle, typeInitializer?: ConstructorInfo, underlyingSystemType?: Type }