Authenticate a user and return an access token.

{
  "email": "user@example.com",
  "secret": "your-password",
  "tfaCode": "123456"
}

Initiate a login flow for a given email address.

{
  "email": "user@example.com"
}

Terminate the current session.

{}

Refresh the current access token.

x-refresh-token: <refreshToken>

Return the current user profile in the selected organization context.

x-active-organization-id: <organizationId>

Change the current user password.

{
  "password": "new-password",
  "oldPassword": "current-password"
}

Create a two-factor authentication method for the current user.

{
  "password": "current-password",
  "type": "totp"
}

Activate a previously created two-factor authentication method.

{
  "tfaCode": "123456"
}

Disable a two-factor authentication method.

{
  "tfaId": "<tfaId>",
  "password": "current-password"
}

Remove a two-factor authentication method.

{
  "tfaId": "<tfaId>",
  "password": "current-password"
}

List configured two-factor authentication methods for the current user.

List organizations available to the authenticated user.

Create an API key for a given organization profile.

{
  "profileId": "<profileId>"
}

List API keys for a given organization profile.

{
  "profileId": "<profileId>"
}

Set or remove feature flags on an organization profile.

{
  "profileId": "<profileId>",
  "flags": [
    {
      "flag": "GHGP",
      "value": true
    },
    {
      "flag": "BOOK_AND_CLAIM",
      "value": null
    }
  ]
}

List users associated with the current organization.

{}

Invite a user to an organization.

{
  "organizationId": "<organizationId>",
  "email": "new.user@example.com",
  "firstName": "First",
  "lastName": "Last"
}

Resend an invitation for an existing organization user.

{
  "organizationId": "<organizationId>",
  "userId": "<userId>"
}

Assign organization-level roles to a user.

{
  "organizationId": "<organizationId>",
  "userId": "<userId>",
  "defaultRoleCodes": ["default.organization.admin"],
  "roleCodes": ["basic.admin"]
}

Assign organization-profile-level roles to a user.

{
  "profileId": "<profileId>",
  "userId": "<userId>",
  "roleCodes": ["basic.admin"]
}

Create a business location associated with an organization profile.

{
  "profileId": "<profileId>",
  "name": "Location Name",
  "type": "buying",
  "basin": "Permian",
  "isDirectConnection": false,
  "preferredSuppliers": ["Antero"],
  "coordinates": {
    "latitude": 31.972096,
    "longitude": -83.760640
  },
  "address": {
    "country": "US"
  }
}

Update a business location.

{
  "_id": "<businessLocationId>",
  "basin": "Permian",
  "isDirectConnection": true,
  "preferredSuppliers": ["QB"],
  "name": "Updated Location",
  "address": {
    "country": "US",
    "state": "NY"
  },
  "status": "active"
}

Return details for a business location.

{
  "_id": "<businessLocationId>"
}

List business locations for a given profile.

{
  "profileId": "<profileId>"
}

{
  "email": "user@example.com",
  "firstName": "First",
  "lastName": "Last",
  "password": "temporary-password",
  "roleLinks": []
}

{
  "_id": "<userId>",
  "firstName": "UpdatedFirstName"
}

{
  "userId": "<userId>",
  "roleLinks": [
    {
      "roleCode": "default.organization.admin",
      "entityType": "organization",
      "entityId": "<organizationId>"
    },
    {
      "roleCode": "sox.producer.admin",
      "entityType": "organization_profile",
      "entityId": "<profileId>"
    }
  ]
}

{
  "userId": "<userId>",
  "roleLinks": [
    {
      "roleCode": "default.organization.admin",
      "entityType": "organization",
      "entityId": "<organizationId>"
    }
  ]
}

{
  "userId": "<userId>",
  "password": "new-password"
}

{
  "userId": "<userId>"
}

{
  "email": "partial-or-full-email"
}

{
  "userId": "<userId>"
}

{
  "userId": "<userId>",
  "tfaId": "<tfaId>"
}

{
  "name": "Organization Name",
  "taxId": "123456789",
  "duns": "123456789"
}

{
  "_id": "<organizationId>",
  "name": "Updated Organization Name",
  "taxId": "",
  "status": "archive",
  "address": {}
}

{}

client-id: <clientId>
client-key: <clientKey>

{
  "name": "Organization Profile Name",
  "organizationId": "<organizationId>",
  "taxId": "800162034",
  "duns": "831003012",
  "participantTypes": ["producer"],
  "participantTags": [
    {
      "tag": "nat_gas_producer"
    }
  ]
}

{
  "_id": "<profileId>",
  "participantTags": [
    {
      "tag": "nat_gas_producer",
      "measurers": [
        {"identifier": "mock-server", "standardTypes": ["OGCI", "NGSI"]},
        {"identifier": "project-canary", "standardTypes": ["OGCI"]}
      ],
      "verifiers": [
        {"identifier": "demo_verifier"},
        {"identifier": "spirit"}
      ]
    },
    {
      "tag": "nat_gas_transportation_producer"
    },
    {
      "tag": "nat_gas_buyer"
    },
    {
      "tag": "nat_gas_transportation_buyer"
    }
  ]
}

{
  "participantTags": [
    {"tag": "nat_gas_transportation_producer"}
  ]
}

client-id: <clientId>
client-key: <clientKey>

{
  "profileId": "<profileId>",
  "name": "Location Name",
  "coordinates": {
    "latitude": 31.972096,
    "longitude": -83.760640
  },
  "address": {
    "country": "US"
  }
}

{
  "_id": "<businessLocationId>",
  "name": "Updated Name",
  "address": {
    "country": "US",
    "state": "NY"
  },
  "status": "active"
}

{
  "_id": "<businessLocationId>"
}

{
  "profileId": "<profileId>"
}

{}

{}

{}

{
  "password": "temporary-password"
}

{
  "template": "retirement",
  "data": {}
}

{
  "template": "retirement1",
  "data": {}
}