Azure Active Directory (AAD)

Get authorization URL for Active Directory

get

Generates and returns the authorization URL for Active Directory with the provided company ID.

Query parameters

company_idintegerRequired

The ID of the company for which the authorization URL is generated.

Example: 98765

Responses

200

success

application/json

get

/aad

HTTPcURLJavaScriptPython

GET /aad?company_id=98765 HTTP/1.1
Host: api.taag.co
Accept: */*

200

success

{
  "status": "success",
  "auth_url": "https://login.microsoftonline.com/authorize?client_id=xyz&company_id=98765"
}

Remove connected Active Directory account

delete

Removes the Active Directory integration account for the specified company ID.

Body

application/json

company_idintegerRequired

The ID of the company for which the Active Directory account will be removed.

Example: 98765

Responses

200

success

application/json

delete

/aad

HTTPcURLJavaScriptPython

DELETE /aad HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "company_id": 98765
}

200

success

{
  "status": "success"
}

Get access token

get

Exchanges the provided authorization token for an access token using the company ID and user session.

Query parameters

company_idintegerRequired

The ID of the company for which the token is being requested.

Example: 98765

auth_tokenstringRequired

The authorization token received from the authorization URL.

Example: abcdef123456

Responses

200

success

application/json

get

/aad/token

HTTPcURLJavaScriptPython

GET /aad/token?company_id=98765&auth_token=abcdef123456 HTTP/1.1
Host: api.taag.co
Accept: */*

200

success

{
  "status": "success",
  "token": "ya29.A0ARrdaM..."
}

Update users from Azure Active Directory

put

Synchronizes the user data from Azure Active Directory for the specified company ID.

Body

application/json

company_idintegerRequired

The ID of the company for which the users will be synchronized.

Example: 98765

Responses

200

success

application/json

put

/aad/users

HTTPcURLJavaScriptPython

PUT /aad/users HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "company_id": 98765
}

200

success

{
  "status": "success"
}

Update Azure AD configuration

put

Updates the configuration settings for Azure Active Directory integration for a specified company.

Body

application/json

company_idintegerRequired

The ID of the company whose configuration is being updated.

Example: 98765

azure_groupsstringRequired

Comma-separated list of Azure group IDs.

Example: azure-group-id-1,azure-group-id-2,azure-group-id-3

frequencyone ofRequired

Frequency of synchronization (e.g., day, week).

Example: day

stringOptionalExample: day

or

stringOptionalExample: week

or

stringOptionalExample: month

field_mappingsobject[]Optional

Mapping of fields between Azure AD and the application.

Example: [{"company":["companyName"]},{"name":["displayName","givenName"]}]

fetch_fieldsstringOptional

Fields to fetch from Azure AD during synchronization.

Example: displayName, companyName

invitation_emailone ofOptional

Whether to send an invitation email to new users.

integerOptionalExample: 1

or

integerOptionalExample: 0

send_walletone ofOptional

Flag indicating whether to send a wallet card to new users.

integerOptionalExample: 1

or

integerOptionalExample: 0

Responses

200

success

application/json

put

/aad/config

HTTPcURLJavaScriptPython

PUT /aad/config HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "company_id": 98765,
  "azure_groups": "azure-group-id-1,azure-group-id-2,azure-group-id-3",
  "frequency": "day",
  "field_mappings": [
    [
      {
        "company": [
          "companyName"
        ]
      },
      {
        "name": [
          "displayName",
          "givenName"
        ]
      }
    ]
  ],
  "fetch_fields": "displayName, companyName",
  "invitation_email": 1,
  "send_wallet": 1
}

200

success

{
  "status": "success"
}

Retrieve Azure AD groups

get

Fetches Azure Active Directory groups for a specified company. Optionally, specific group IDs can be provided.

Query parameters

company_idintegerRequired

The ID of the company for which the groups are being fetched.

Example: 98765

group_idsstringOptional

Comma-separated list of group IDs to fetch specific groups.

Example: group1,group2,group3

Responses

200

success

application/json

get

/aad/group

HTTPcURLJavaScriptPython

GET /aad/group?company_id=98765 HTTP/1.1
Host: api.taag.co
Accept: */*

200

success

{
  "status": "success",
  "group": [
    {
      "id": "group1",
      "name": "Marketing",
      "description": "Group for the marketing department."
    }
  ]
}

Search Azure AD groups

get

Searches for Azure Active Directory groups based on a query string for a specified company.

Query parameters

company_idintegerRequired

The ID of the company within which the search is conducted.

Example: 98765

querystringRequired

The search query used to find matching groups.

Example: marketing

Responses

200

success

application/json

get

/aad/groups/search

HTTPcURLJavaScriptPython

GET /aad/groups/search?company_id=98765&query=marketing HTTP/1.1
Host: api.taag.co
Accept: */*

200

success

{
  "status": "success",
  "groups": [
    {
      "id": "group1",
      "name": "Marketing",
      "description": "Group for the marketing department."
    }
  ]
}

Get connected user and configuration status

get

Retrieves the connected user's details and configuration status for a specified company from Azure Active Directory.

Query parameters

company_idintegerRequired

The ID of the company for which the status is being retrieved.

Example: 98765

Responses

200

success

application/json

get

/aad/status

HTTPcURLJavaScriptPython

GET /aad/status?company_id=98765 HTTP/1.1
Host: api.taag.co
Accept: */*

200

success

{
  "status": "success",
  "token": "ya29.A0ARrdaM...",
  "frequency": "day",
  "groupData": [
    {
      "name": "Marketing",
      "id": "group1"
    }
  ],
  "field_mappings": [
    [
      {
        "company": [
          "companyName"
        ]
      },
      {
        "name": [
          "displayName",
          "givenName"
        ]
      }
    ]
  ],
  "fetch_fields": "displayName, companyName",
  "invitation_email": 1,
  "send_wallet": 1
}