> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/automation/runbooks/runbook-references/user/security/create-temporary-access-pass.md). # Create Temporary Access Pass ### Description Creates a new Temporary Access Pass (TAP) authentication method for a user in Microsoft Entra ID. Existing TAPs for the user are removed before creating a new one. Optionally sends a notification email to the user's primary email address informing them about the newly created TAP. The email language is automatically determined by the user's usage location. ### Activate user notification This runbook sends an email to the user with the temporary access pass. To enable this, you need to activate user notification in the runbook customization. The json configuration for this is as follows: ```json "rjgit-user_security_create-temporary-access-pass": { "parameters": { "UserName": { "Hide": true }, "NotifyUser": { "Default": true, "Hide": true }, "EmailFrom": { "Hide": true }, "ServiceDeskDisplayName": { "Hide": true }, "ServiceDeskEmail": { "Hide": true }, "ServiceDeskPhone": { "Hide": true }, "ServiceDeskPortalUrl": { "Hide": true }, "ServiceDeskTicketUrl": { "Hide": true }, "CallerName": { "Hide": true } } } ``` For more information on how to customize runbooks, please refer to the [Runbook Customization Guide](https://docs.realmjoin.com/automation/runbooks/runbook-customization). ### Setup regarding email sending Sending an email report is optional and only happens when a recipient (`EmailTo`) is provided. The sender address is taken from the `RJReport.EmailSender` tenant setting. This runbook sends emails using the Microsoft Graph API. To send emails via Graph API, you need to configure an existing email address in the runbook customization. See the [RealmJoin Report Settings documentation](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings) for details. #### Email branding The report email honors the optional `RJReport.Branding.*` tenant settings: a custom header image, a custom footer image (public HTTPS URLs, PNG/JPEG/GIF, max. 200 KB each), a custom footer link, and custom accent and text colors (6-digit hex values, e.g. `#0052cc`). When these settings are not configured, the default RealmJoin graphics and colors are used. A branding image that cannot be downloaded or validated, or a color value that is not a valid hex color, never prevents the report email - the corresponding default is used instead. See the [RealmJoin Report Settings documentation](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings) for setup details. ### Location User → Security → Create Temporary Access Pass **Full Runbook name** rjgit-user\_security\_create-temporary-access-pass ### Details | Property | Value | | ---------------- | ---------------------------------- | | Version | 1.4.0 | | Required modules | RealmJoin.RunbookHelper (>= 0.8.9) | | Schedulable | no | ### Permissions #### Application permissions * **Type**: Microsoft Graph * UserAuthenticationMethod.ReadWrite.All * *Deletes existing Temporary Access Passes and creates the new one* * User.Read.All * *Reads the user's mail and usage location via /users/{UPN} for output and notification* * Mail.Send *(optional — feature: Email notification)* * *Mails the new Temporary Access Pass to the user when NotifyUser is enabled* ### Parameters #### UserName User principal name of the target user. | Property | Value | | ---------------- | -------------------------------------- | | Required | true | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### LifetimeInMinutes Lifetime of the temporary access pass in minutes. Valid values are between 60 and 480 minutes (1-8 hours). | Property | Value | | ------------- | ----- | | Required | false | | Default Value | 240 | | Type | Int32 | #### OneTimeUseOnly If set to true, the pass can be used only once. | Property | Value | | ------------- | ------- | | Required | false | | Default Value | True | | Type | Boolean | #### NotifyUser If enabled, sends a notification email to the user's primary email address about the newly created TAP. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | False | | Type | Boolean | | Hidden in portal | yes (preset via runbook customization) | #### EmailFrom The sender email address. This needs to be configured in the runbook customization. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### BrandingHeaderImageUrl Optional public HTTPS URL of a custom header image (PNG/JPEG/GIF, max. 200 KB) for the report email. Sourced from the RJReport.Branding.HeaderImageUrl tenant setting. When empty, the default RealmJoin header graphic is used. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### BrandingFooterImageUrl Optional public HTTPS URL of a custom footer image (PNG/JPEG/GIF, max. 200 KB) for the report email. Sourced from the RJReport.Branding.FooterImageUrl tenant setting. When empty, the default RealmJoin footer graphic is used. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### BrandingFooterLink Optional URL the footer image links to. Sourced from the RJReport.Branding.FooterLink tenant setting. When empty, the default link () is used. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### BrandingAccentColor Optional accent color override (6-digit hex, e.g. '#0052cc') for the report email template. Sourced from the RJReport.Branding.AccentColor tenant setting. When empty or invalid, the default RealmJoin accent color is used. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### BrandingTextColor Optional text color override (6-digit hex) for the report email template. Sourced from the RJReport.Branding.TextColor tenant setting. When empty or invalid, the default RealmJoin text color is used. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### ServiceDeskDisplayName Service Desk display name for user contact information (optional). | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### ServiceDeskEmail Service Desk email address for user contact information (optional). | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### ServiceDeskPhone Service Desk phone number for user contact information (optional). | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### ServiceDeskPortalUrl Service Desk portal URL for user contact information, rendered as a clickable link (optional). | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | #### ServiceDeskTicketUrl Direct link to the Service Desk ticket related to this request, rendered as a clickable link (optional). Empty by default, so no ticket link is added. | Property | Value | | ---------------- | -------------------------------------- | | Required | false | | Default Value | | | Type | String | | Hidden in portal | yes (preset via runbook customization) | [Back to Runbook Reference overview](/automation/runbooks/runbook-references.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.realmjoin.com/automation/runbooks/runbook-references/user/security/create-temporary-access-pass.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.