yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-24 07:14:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.5.x/main-concepts/metadata-standard/schemas/api/teams/createUser.md
Pere Miquel Brull 60ed221cf1
DOCS - Update Version Snapshots (#17589)
2024-08-27 14:41:12 +05:30

1.9 KiB
Raw Blame History

title slug
createUser /main-concepts/metadata-standard/schemas/api/teams/createuser

CreateUserRequest

Request to create User entity

Properties

  • name: Refer to ../../entity/teams/user.json#/definitions/entityName.
  • description: Used for user biography. Refer to ../../type/basic.json#/definitions/markdown.
  • displayName (string): Name used for display purposes. Example 'FirstName LastName'.
  • email: Refer to ../../type/basic.json#/definitions/email.
  • timezone (string): Timezone of the user.
  • isBot (boolean): When true indicates user is a bot with appropriate privileges.
  • botName (string): User bot name if we want to associate this bot with an specific bot.
  • isAdmin (boolean): When true indicates user is an administrator for the system with superuser privileges. Default: False.
  • profile: Refer to ../../type/profile.json. Default: None.
  • teams (array): Teams that the user belongs to. Default: None.
    • Items: Refer to ../../type/basic.json#/definitions/uuid.
  • roles (array): Roles that the user has been assigned. Default: None.
    • Items: Refer to ../../type/basic.json#/definitions/uuid.
  • personas: Persona that the user belongs to. Refer to ../../type/entityReferenceList.json.
  • defaultPersona: Default Persona from User's Personas. Refer to ../../type/entityReference.json.
  • authenticationMechanism: Authentication mechanism specified . Refer to ../../entity/teams/user.json#/definitions/authenticationMechanism. Default: None.
  • createPasswordType (string): User Password Method. Must be one of: ['ADMIN_CREATE', 'USER_CREATE']. Default: USER_CREATE.
  • password (string): Password for User.
  • confirmPassword (string): Confirm Password for User.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.