Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Users / Create Temporary Access Pass

  • Article
  • 3 minutes to read

Operation Information

Hornbill iBridge integration to create a new Temporary Access Pass in Entra ID (previously Azure AD).

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Entra ID Authentication Management.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Entra ID Authentication Management in the Type pick list;
  • Give the Entra ID Authentication Management KeySafe key a Title (this is the name / identifier for the Entra ID Authentication Management account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Entra ID Authentication Management account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
UPN/ID UPN string User Principle Name or ID of the user Yes None provided
Is Usable Once isUsableOnce boolean Determines if the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within its Lifetime In Minutes setting. No None provided
Lifetime In Minutes lifetimeInMinutes integer The lifetime of the temporaryAccessPass in minutes starting at creation time or at startDateTime, if set. Must be between 10 and 43200 (equivalent to 30 days). No None provided
Start DateTime startDateTime string The date and time when the temporaryAccessPass becomes available to use. If not specified, the Temporary Access Pass is available to use immediately after it’s created. e.g. 2022-06-05T00:00:00Z No None provided

Output Parameters

Display Name ID Type Description
Status status string Return Status
Error error string Any returned errors
ID id string The ID of the User
Temporary Access Pass temporaryAccessPass string The Temporary Access Pass used to authenticate
Created DateTime createdDateTime string The date and time when the Temporary Access Pass was created
Start Date Time startDateTime string The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
Lifetime In Minutes lifetimeInMinutes integer The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
Is Usable Once isUsableOnce boolean Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime
Is Usable isUsable boolean The state of the authentication method that indicates whether it’s currently usable by the user.
Method Usability Reason methodUsabilityReason string Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document