Setting up an authorization

This guide explains how to set up an authorization to a data source or destination.

Introduction

What is an authorization?

An authorization gives Adverity access to a data source or a destination. You need to create an authorization to collect data and load it into external destinations. You can use one authorization to create multiple datastreams and destinations.

What do I need to create an authorization?

To set up an authorization, you need to provide valid credentials, such as a username and password, or an API Key, for example. The credentials required differ for each data source and destination. If you do not have credentials to create an authorization, you can ask someone else to create an authorization for you.

What are Billing Objects?

Most authorizations give Adverity access to multiple items that are linked to the authorization, such as accounts or profiles. In Adverity, these items are known as Billing Objects. When you create an authorization, you choose which Billing Objects Adverity can access.

If an authorization does not ask you to select the Billing Objects you want to give Adverity access to, this means that the authorization only grants Adverity access to a single item, for example a single account.

Who can use an authorization that I create?

An authorization is available to use in the workspace in which it was created, and any child workspaces belonging to this workspace. This means that all users with access to these workspaces can use the authorization to collect or load data.

Creating an authorization

Using your own credentials to create an authorization

If you have valid credentials for the data source or destination you want to authorize Adverity to access, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Authorizations.

  2. In the top right corner of the page, click + Create authorization.

  3. Search for and click the data source or destination for which you want to create an authorization.

  4. Click Access using your credentials.

  5. Use your credentials to create the authorization:

    • For some authorizations, click Next and then enter the required credentials (for example, a username and password).

    • For some authorizations, you will be taken to a login page where you can enter your credentials to authorize Adverity.

  6. If you are creating an authorization for a data source with Billing Objects, choose which Billing Objects Adverity can access using this authorization:

    • Grant access to all Billing Objects, including those created in the future - Select this option to allow Adverity to access all Billing Objects associated with the credentials you have used. Adverity will also have access to all associated Billing Objects created in the future.

    • Select specific Billing Objects to which you want to grant access - Select this option to only allow Adverity to access the Billing Objects you choose in this step. You will need to grant Adverity access to any associated Billing Objects that are created in the future.

  7. Click Confirm.

As a result, the authorization is set up and you are taken to the authorization overview page. For more information about updating, deleting and synchronizing authorizations, see Managing authorizations.

Important information about Billing Objects

If you use your credentials to grant Adverity access to a connector, all the Billing Objects available to you using your credentials will be visible in the Authorizations page to all Adverity users with permission to edit this authorization.

If someone else uses their credentials to grant Adverity access to a connector, the same applies to the Billing Objects available using their credentials.

This is important to consider if you do not want all Adverity users with permission to edit the authorization to be able to see the details of the Billing Objects. For more information about user permissions, see Managing user permissions.

Asking someone else to create an authorization

If you do not have the required credentials for the data source or destination you want to authorize Adverity to access, you can ask someone else to create an authorization for you. The person you ask then needs to follow the steps set out in Responding to an authorization request below.

To ask someone else to create an authorization for you, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Authorizations.

  2. In the top right corner of the page, click + Create authorization.

  3. Search for and click the connector or destination for which you want to create an authorization.

  4. Click Access using someone else's credentials.

  1. Click Next.

  1. Fill in the following fields:

    Email

    Enter the email address of the person you want to ask to create the authorization.

    Authorizations added

    (Optional) Rename the authorization that you want the recipient to create.

    (Optional) Ask the recipient to create additional authorizations to different data sources or destinations:

    1. Click + Add more authorizations.

    2. In the Add authorization window, search for and click the data source or destination for which you want an authorization.

    3. Click Add authorization.

    Message

    (Optional) In the Message field, change the email message.

    Do not remove the {{links}} placeholder from the message field. The recipient needs these links to create the authorizations.

    Notification email

    (Optional) Enter any email addresses that you want to receive a notification when the authorization has been created.

  2. Click Send access request.

As a result, an email is sent to the email address in the Email field to request the authorization or authorizations for you.

Authorization requests are shown in the Authorizations page with the status Access pending. If a pending authorization is not authorized within 7 days, it will expire. Click next to a pending authorization to see when it will expire.

The person granting the request will need to choose which Billing Objects Adverity can access. If the data source has a lot of Billing Objects, it may take a long time for the Billing Objects objects to load before the recipient can create the authorization.

After the authorization has been granted, an email notification will be sent to the email addresses you entered in the Notification email field. You can then use this authorization to collect data from the corresponding data source or load data into the corresponding destination.

Responding to an authorization request

If you receive an Adverity Authorization Request email, an Adverity user has asked you to give Adverity access to a data source. To grant this authorization, follow these steps:

  1. Click the link in the email. This link is the name that the user who sent the request has given the authorization.

  2. Use your credentials to create the authorization:

    • For some authorizations, you will be taken to the Adverity platform and asked to enter the required credentials (for example, a username and password).

    • For some authorizations, you will be taken to a login page for the corresponding data source where you can enter your credentials to authorize Adverity.

  3. If this data source has Billing Objects, choose which Billing Objects Adverity can access using this authorization. For more information, see What are Billing Objects? and Important information about Billing Objects. Select one of the following options:

    • Grant access to all Billing Objects, including those created in the future - Select this option to allow Adverity to access all Billing Objects associated with the credentials you have used. Adverity will also have access to all associated Billing Objects created in the future.

    • Select specific Billing Objects to which you want to grant access - Select this option to only allow Adverity to access the Billing Objects you choose in this step. You will need to grant Adverity access to any associated Billing Objects that are created in the future.

  4. Click Authorize.

As a result, you have granted Adverity access to the data source or destination using your credentials. This authorization can now be used to create datastreams to fetch data from this data source or load data into this destination.

Video guide: How to set up authorizations in Adverity

This video guide explains how to create authorizations in Adverity using your own credentials, and by asking someone else to create the authorization using their credentials.