okta_api v0.1.10 Okta.TrustedOrigins View Source

The Okta.TrustedOrigins module provides access methods to the Okta Trusted Origins API.

All methods require a Tesla Client struct created with Okta.client(base_url, api_key).

Examples

client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
{:ok, result, _env} = Okta.TrustedOrigins.list_trusted_origins(client)

Link to this section Summary

Link to this section Functions

Link to this function

activate_trusted_origin(client, trusted_origin_id)

View Source
activate_trusted_origin(Okta.client(), String.t()) :: Okta.result()

Activates an existing trusted origin

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.activate_trusted_origin(client, "tosue7JvguwJ7U6kz0g3")

https://developer.okta.com/docs/reference/api/trusted-origins/#activate-trusted-origin

Link to this function

create_trusted_origin(client, name, origin, scopes)

View Source
create_trusted_origin(Okta.client(), String.t(), String.t(), [:cors | :redirect]) ::
  Okta.result()

Creates a new trusted origin

The scopes parameter is a List with one or both of :cors and :redirect

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.create_trusted_origin(client, "Test", "https://example.com/test", [:cors, :redirect])

https://developer.okta.com/docs/reference/api/trusted-origins/#create-trusted-origin

Link to this function

deactivate_trusted_origin(client, trusted_origin_id)

View Source
deactivate_trusted_origin(Okta.client(), String.t()) :: Okta.result()

Deactivates an existing trusted origin

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.deactivate_trusted_origin(client, "tosue7JvguwJ7U6kz0g3")

https://developer.okta.com/docs/reference/api/trusted-origins/#deactivate-trusted-origin

Link to this function

delete_trusted_origin(client, trusted_origin_id)

View Source
delete_trusted_origin(Okta.client(), String.t()) :: Okta.result()

Deletes an existing trusted origin

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.delete_trusted_origin(client, "tosue7JvguwJ7U6kz0g3")

https://developer.okta.com/docs/reference/api/trusted-origins/#delete-trusted-origin

Link to this function

filter_trusted_origins(client, filter, opts \\ [])

View Source
filter_trusted_origins(Okta.client(), String.t(), keyword()) :: Okta.result()

Lists all trusted origins with a filter

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.filter_trusted_origins(client, "(id eq "tosue7JvguwJ7U6kz0g3" or id eq "tos10hzarOl8zfPM80g4")")

https://developer.okta.com/docs/reference/api/trusted-origins/#list-trusted-origins-with-a-filter

Link to this function

get_trusted_origin(client, trusted_origin_id)

View Source
get_trusted_origin(Okta.client(), String.t()) :: Okta.result()

Gets a trusted origin by ID

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.get_trusted_origin(client, "tosue7JvguwJ7U6kz0g3")

https://developer.okta.com/docs/reference/api/trusted-origins/#get-trusted-origin

Link to this function

list_trusted_origins(client, opts \\ [])

View Source
list_trusted_origins(Okta.client(), keyword()) :: Okta.result()

Lists all trusted origins

A subset of trusted origins can be returned that match a supported filter expression or query criteria.

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.list_trusted_origins(client, limit: 1000)

https://developer.okta.com/docs/reference/api/trusted-origins/#list-trusted-origins

Link to this function

update_trusted_origin(client, trusted_origin_id, name, origin, scopes)

View Source
update_trusted_origin(Okta.client(), String.t(), String.t(), String.t(), [
  :cors | :redirect
]) :: Okta.result()

Updates a trusted origin

The scopes parameter is a List with one or both of :cors and :redirect

Examples

    client = Okta.Client("https://dev-000000.okta.com", "thisismykeycreatedinokta")
    {:ok, result, _env} = Okta.TrustedOrigins.update_trusted_origin(client, "tosue7JvguwJ7U6kz0g3", "Test", "https://example.com/test", [:cors, :redirect])

https://developer.okta.com/docs/reference/api/trusted-origins/#update-trusted-origin