# `Oidcc.Logout`
[🔗](https://github.com/erlef/oidcc/blob/ee3434ddec86c14471af8f8a8f159971e654da3c
/lib/oidcc/logout.ex#L4)

Logout from the OpenID Provider

# `initiate_url`
*since 3.0.0* 

```elixir
@spec initiate_url(
  token :: id_token | Oidcc.Token.t() | :undefined,
  client_context :: Oidcc.ClientContext.t(),
  opts :: :oidcc_logout.initiate_url_opts()
) :: {:ok, :uri_string.uri_string()} | {:error, :oidcc_logout.error()}
when id_token: String.t()
```

Initiate URI for Relaying Party initiated Logout

See https://openid.net/specs/openid-connect-rpinitiated-1_0.html#RPLogout

For a high level interface using `Oidcc.ProviderConfiguration.Worker`
see `Oidcc.initiate_logout_url/4`.

## Examples

    iex> {:ok, pid} =
    ...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
    ...>     issuer: "https://erlef-test-w4a8z2.zitadel.cloud"
    ...>   })
    ...>
    ...> {:ok, client_context} =
    ...>   Oidcc.ClientContext.from_configuration_worker(
    ...>     pid,
    ...>     "client_id",
    ...>     :unauthenticated
    ...>   )
    ...>
    ...> # Get `token` from `Oidcc.retrieve_token/5`
    ...> token = "token"
    ...>
    ...> {:ok, _redirect_uri} =
    ...>   Oidcc.Logout.initiate_url(
    ...>     token,
    ...>     client_context,
    ...>     %{post_logout_redirect_uri: "https://my.server/return"}
    ...>   )

---

*Consult [api-reference.md](api-reference.md) for complete listing*