emnify Password Management And Activation API

openapi: 3.2.0
info:
  title: Enterprise Password Management And Activation API
  version: 1.0.0
  description: Password management and activation services
servers:
- url: https://cdn.emnify.net
  description: emnify REST API
tags:
- name: passwordManagementAndActivation
  description: Password management and activation services
paths:
  /api/v2/user/invitation:
    post:
      operationId: passwordManagementAndActivation_UserV2Invitation
      summary: Invite a user
      description: 'Required permissions Beta Learn more


        `User.Invitation` + `Create`


        Roles: Administrator


        Invite a user to a Workspace by specifying username and the roles that the user will have in the organization.

        This user is created and a `User invited` event is sent.

        There is no additional action such as an email sent.


        The following fields may be provided:

        - `username` (String) - Email of the invited user

        - `name` (String) - Name of the invited user

        - `organisation` (Object) - Defaults to the default Workspace of the requesting user

        - `roles` (Array) - Assigns the **Administrator** role by default


        If the invited user doesn''t exist, a new user is created and the `organisation.id` is their default Workspace.

        If the invited user already exists, the user is assigned to the Workspace.

        This fails if the Workspace feature isn''t enabled on the target organization''s tariff plan.'
      tags:
      - passwordManagementAndActivation
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Password_management_and_activation_UserV2Invitation_Response_201'
        '400':
          description: 'Some of the given parameters have invalid values, detailed description will be given in the response

            '
          content:
            application/json:
              schema:
                description: Any type
        '403':
          description: 'Current logged in user is not permitted to invite users.

            '
          content:
            application/json:
              schema:
                description: Any type
        '409':
          description: 'There is already an active user with the same username, so this cannot be taken

            '
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                name:
                  type: string
                organisation:
                  $ref: '#/components/schemas/ApiV2UserInvitationPostRequestBodyContentApplicationJsonSchemaOrganisation'
                roles:
                  type: array
                  items:
                    $ref: '#/components/schemas/ApiV2UserInvitationPostRequestBodyContentApplicationJsonSchemaRolesItems'
              required:
              - username
              - name
      security:
      - bearerAuth: []
  /api/v1/user/activation:
    post:
      operationId: passwordManagementAndActivation_UserActivationPost
      summary: Activate user
      description: 'Required permissions Beta Learn more


        Public endpoint. No permission required.


        Activates the user account and sets a password.

        The activation key is sent via email.


        This is a public (unauthenticated) service which ignores auth tokens.'
      tags:
      - passwordManagementAndActivation
      responses:
        '204':
          description: The server has successfully fulfilled the request and that there is no additional content to send in the response payload body
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                activationKey:
                  type: string
                password:
                  type: string
              required:
              - activationKey
              - password
  /api/v1/user/activation_resend:
    post:
      operationId: passwordManagementAndActivation_UserActivationResendPost
      summary: Resend user activation email
      description: 'Required permissions Beta Learn more


        Public endpoint. No permission required.


        Re-sends activation mail to the user.


        As this endpoint is open to the public (no authentication token necessary), it requires instead the google reCAPTCHA token to ensure that no robot is performing the request.

        Moreover, there''s a time limit on how often a given user may be issued with a new activation mail.


        According to the reCAPTCHA documentation a "Site Key" is necessary.

        If you want to implement this feature in your client, please contact emnify support to obtain this "Site Key" for your domain.'
      tags:
      - passwordManagementAndActivation
      responses:
        '204':
          description: The server has successfully fulfilled the request and that there is no additional content to send in the response payload body
          content:
            application/json:
              schema:
                type: object
                properties: {}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                g-recaptcha-response:
                  type: string
                  description: 'Auto-generated from a form using Google reCAPTCHA.

                    '
              required:
              - username
              - g-recaptcha-response
  /api/v1/user/password:
    patch:
      operationId: passwordManagementAndActivation_UserPasswordPatch
      summary: Change password
      description: 'Required permissions Beta Learn more


        No permission required. Available to all roles.


        Changes the password for the currently authenticated user.


        The client application should invalidate the authentication token.'
      tags:
      - passwordManagementAndActivation
      responses:
        '204':
          description: The server has successfully fulfilled the request and that there is no additional content to send in the response payload body
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '422':
          description: See HTTP response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPasswordPatchRequestUnprocessableEntityError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                old_password:
                  type: string
                new_password:
                  type: string
              required:
              - old_password
              - new_password
      security:
      - bearerAuth: []
components:
  schemas:
    ApiV1UserPasswordPatchResponsesContentApplicationJsonSchemaErrorsItems:
      type: object
      properties: {}
      title: ApiV1UserPasswordPatchResponsesContentApplicationJsonSchemaErrorsItems
    UserPasswordPatchRequestUnprocessableEntityError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        message:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiV1UserPasswordPatchResponsesContentApplicationJsonSchemaErrorsItems'
      title: UserPasswordPatchRequestUnprocessableEntityError
    Password_management_and_activation_UserV2Invitation_Response_201:
      type: object
      properties:
        id:
          type: number
          format: double
        username:
          type: string
        name:
          type: string
        organisation:
          $ref: '#/components/schemas/ApiV2UserInvitationPostResponsesContentApplicationJsonSchemaOrganisation'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/ApiV2UserInvitationPostResponsesContentApplicationJsonSchemaRolesItems'
      title: Password management and activation_UserV2Invitation_Response_201
    ApiV2UserInvitationPostResponsesContentApplicationJsonSchemaRolesItems:
      type: object
      properties:
        id:
          type: number
          format: double
        name:
          type: string
      title: ApiV2UserInvitationPostResponsesContentApplicationJsonSchemaRolesItems
    ApiV2UserInvitationPostRequestBodyContentApplicationJsonSchemaRolesItems:
      type: object
      properties:
        id:
          type: integer
      title: ApiV2UserInvitationPostRequestBodyContentApplicationJsonSchemaRolesItems
    ApiV2UserInvitationPostResponsesContentApplicationJsonSchemaOrganisation:
      type: object
      properties:
        id:
          type: number
          format: double
      title: ApiV2UserInvitationPostResponsesContentApplicationJsonSchemaOrganisation
    ApiV2UserInvitationPostRequestBodyContentApplicationJsonSchemaOrganisation:
      type: object
      properties:
        id:
          type: integer
      title: ApiV2UserInvitationPostRequestBodyContentApplicationJsonSchemaOrganisation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An `auth_token` should be provided to authenticate a session.


        To obtain an `auth_token`, see the [`/api/v1/authenticate` **POST** request](/developers/api/authentication/authenticate).

        '
x-provenance:
  method: harvested
  publisher: emnify
  source: https://docs.emnify.com/openapi/enterprise.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)