# getPortal

> Function getPortal in pulumi-buildkite.

<!-- Generated from the pulumi-buildkite SDK. -->

Function getPortal in pulumi-buildkite.

Invoke token: `buildkite:index/getPortal:getPortal`.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as buildkite from "pulumi-buildkite"

const result = await buildkite.getPortal({
  slug: "<slug>",
})
```

`getPortalOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property | Type     | Required | Description |
| -------- | -------- | -------- | ----------- |
| `slug`   | `string` | yes      |             |

## Result

| Property             | Type                 | Always present | Description |
| -------------------- | -------------------- | -------------- | ----------- |
| `allowedIpAddresses` | `string`             | yes            |             |
| `createdAt`          | `string`             | yes            |             |
| `createdBy`          | `GetPortalCreatedBy` | yes            |             |
| `description`        | `string`             | yes            |             |
| `name`               | `string`             | yes            |             |
| `query`              | `string`             | yes            |             |
| `slug`               | `string`             | yes            |             |
| `userInvokable`      | `boolean`            | yes            |             |
| `uuid`               | `string`             | yes            |             |

## `GetPortalCreatedBy`

Output object `GetPortalCreatedBy`. Fields below belong to this object.

| Property | Type     | Always present | Description            |
| -------- | -------- | -------------- | ---------------------- |
| `email`  | `string` | yes            | The email of the user. |
| `name`   | `string` | yes            | The name of the user.  |
| `uuid`   | `string` | yes            | The UUID of the user.  |