> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Log in a portal user

> Checks a portal user's email and password and returns the user with the portals they can open.

Send the portal user's `email` and `password` under `portal`. The response holds the `user` under `portal`, with their name, email address and a `portals` list naming each account they can open. A password that is not the user's current one returns `400`.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /portal/login
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /portal/login:
    post:
      tags:
        - Portal
      summary: Log in a portal user
      description: >-
        Send the portal user's `email` and `password` under `portal`. The
        response holds the `user` under `portal`, with their name, email address
        and a `portals` list naming each account they can open. A password that
        is not the user's current one returns `400`.
      operationId: portals_create_portal_login
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                portal:
                  type: object
                  properties:
                    email:
                      type: string
                      description: The portal user's email address.
                    password:
                      type: string
                      description: The portal user's password.
              required:
                - portal
            example:
              portal:
                email: jane@example.com
                password: current-password
      responses:
        '200':
          description: The portal user, under `portal.user`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalLoginResponse'
        '400':
          description: The password is not the portal user's current password.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/portal/login" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "portal": {
                  "email": "jane@example.com",
                  "password": "current-password"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.portals.create_portal_login(
                {"portal": {"email": "jane@example.com", "password": "current-password"}}
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.portals.createPortalLogin({
                portal: {email: 'jane@example.com', password: 'current-password'},
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->portals->createPortalLogin([
                'portal' => ['email' => 'jane@example.com', 'password' => 'current-password'],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.portals.portals_dto.PortalsDto.PortalLogin;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<PortalLogin> response =
            client.portals().createPortalLogin(
                    Map.of("portal", Map.of("email", "jane@example.com", "password", "current-password")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await client.Portals.CreatePortalLoginAsync(new
            Dictionary<string, object?>

            {
                ["portal"] = new Dictionary<string, object?>
                {
                    ["email"] = "jane@example.com",
                    ["password"] = "current-password",
                },
            });


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.portals.createPortalLogin({
              'portal': {'email': 'jane@example.com', 'password': 'current-password'},
            });
            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Portals().CreatePortalLogin(context.Background(), map[string]any{\n\t\"portal\": map[string]any{\n\t\t\"email\":    \"jane@example.com\",\n\t\t\"password\": \"current-password\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    PortalLoginResponse:
      type: object
      properties:
        portal:
          $ref: '#/components/schemas/PortalLogin'
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                type: string
    PortalLogin:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/PortalLoginUser'
    PortalLoginUser:
      type: object
      properties:
        email_address:
          type: string
        grant_access_portal:
          type: boolean
        image_uri:
          type: string
        name:
          type: string
        portals:
          type: array
          items:
            $ref: '#/components/schemas/PortalLoginUserPortal'
          description: Each account the user can open in the portal.
        type:
          type: string
    PortalLoginUserPortal:
      type: object
      properties:
        account:
          type: string
        display_name:
          type: string
        uuid:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.