Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. OauthClient
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.OauthClient

cloudflare logo
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Accepted Permissions

    • OAuth Client Read
    • OAuth Client Write

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleOauthClient = new cloudflare.OauthClient("example_oauth_client", {
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    clientName: "My OAuth App",
    grantTypes: [
        "authorization_code",
        "refresh_token",
    ],
    redirectUris: ["https://example.com/callback"],
    responseTypes: ["code"],
    scopes: ["account.read"],
    tokenEndpointAuthMethod: "client_secret_post",
    allowedCorsOrigins: ["https://example.com"],
    clientUri: "https://example.com",
    logoUri: "https://example.com/logo.png",
    policyUri: "https://example.com/privacy",
    postLogoutRedirectUris: ["https://example.com/logout"],
    tosUri: "https://example.com/tos",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_oauth_client = cloudflare.OauthClient("example_oauth_client",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    client_name="My OAuth App",
    grant_types=[
        "authorization_code",
        "refresh_token",
    ],
    redirect_uris=["https://example.com/callback"],
    response_types=["code"],
    scopes=["account.read"],
    token_endpoint_auth_method="client_secret_post",
    allowed_cors_origins=["https://example.com"],
    client_uri="https://example.com",
    logo_uri="https://example.com/logo.png",
    policy_uri="https://example.com/privacy",
    post_logout_redirect_uris=["https://example.com/logout"],
    tos_uri="https://example.com/tos")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewOauthClient(ctx, "example_oauth_client", &cloudflare.OauthClientArgs{
			AccountId:  pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			ClientName: pulumi.String("My OAuth App"),
			GrantTypes: pulumi.StringArray{
				pulumi.String("authorization_code"),
				pulumi.String("refresh_token"),
			},
			RedirectUris: pulumi.StringArray{
				pulumi.String("https://example.com/callback"),
			},
			ResponseTypes: pulumi.StringArray{
				pulumi.String("code"),
			},
			Scopes: pulumi.StringArray{
				pulumi.String("account.read"),
			},
			TokenEndpointAuthMethod: pulumi.String("client_secret_post"),
			AllowedCorsOrigins: pulumi.StringArray{
				pulumi.String("https://example.com"),
			},
			ClientUri: pulumi.String("https://example.com"),
			LogoUri:   pulumi.String("https://example.com/logo.png"),
			PolicyUri: pulumi.String("https://example.com/privacy"),
			PostLogoutRedirectUris: pulumi.StringArray{
				pulumi.String("https://example.com/logout"),
			},
			TosUri: pulumi.String("https://example.com/tos"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleOauthClient = new Cloudflare.OauthClient("example_oauth_client", new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ClientName = "My OAuth App",
        GrantTypes = new[]
        {
            "authorization_code",
            "refresh_token",
        },
        RedirectUris = new[]
        {
            "https://example.com/callback",
        },
        ResponseTypes = new[]
        {
            "code",
        },
        Scopes = new[]
        {
            "account.read",
        },
        TokenEndpointAuthMethod = "client_secret_post",
        AllowedCorsOrigins = new[]
        {
            "https://example.com",
        },
        ClientUri = "https://example.com",
        LogoUri = "https://example.com/logo.png",
        PolicyUri = "https://example.com/privacy",
        PostLogoutRedirectUris = new[]
        {
            "https://example.com/logout",
        },
        TosUri = "https://example.com/tos",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.OauthClient;
import com.pulumi.cloudflare.OauthClientArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleOauthClient = new OauthClient("exampleOauthClient", OauthClientArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .clientName("My OAuth App")
            .grantTypes(            
                "authorization_code",
                "refresh_token")
            .redirectUris("https://example.com/callback")
            .responseTypes("code")
            .scopes("account.read")
            .tokenEndpointAuthMethod("client_secret_post")
            .allowedCorsOrigins("https://example.com")
            .clientUri("https://example.com")
            .logoUri("https://example.com/logo.png")
            .policyUri("https://example.com/privacy")
            .postLogoutRedirectUris("https://example.com/logout")
            .tosUri("https://example.com/tos")
            .build());

    }
}

    resources:
  exampleOauthClient:
    type: cloudflare:OauthClient
    name: example_oauth_client
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      clientName: My OAuth App
      grantTypes:
        - authorization_code
        - refresh_token
      redirectUris:
        - https://example.com/callback
      responseTypes:
        - code
      scopes:
        - account.read
      tokenEndpointAuthMethod: client_secret_post
      allowedCorsOrigins:
        - https://example.com
      clientUri: https://example.com
      logoUri: https://example.com/logo.png
      policyUri: https://example.com/privacy
      postLogoutRedirectUris:
        - https://example.com/logout
      tosUri: https://example.com/tos

    pulumi {
  required_providers {
    cloudflare = {
      source = "pulumi/cloudflare"
    }
  }
}

resource "cloudflare_oauthclient" "example_oauth_client" {
  account_id                 = "023e105f4ecef8ad9ca31a8372d0c353"
  client_name                = "My OAuth App"
  grant_types                = ["authorization_code", "refresh_token"]
  redirect_uris              = ["https://example.com/callback"]
  response_types             = ["code"]
  scopes                     = ["account.read"]
  token_endpoint_auth_method = "client_secret_post"
  allowed_cors_origins       = ["https://example.com"]
  client_uri                 = "https://example.com"
  logo_uri                   = "https://example.com/logo.png"
  policy_uri                 = "https://example.com/privacy"
  post_logout_redirect_uris  = ["https://example.com/logout"]
  tos_uri                    = "https://example.com/tos"
}

    Create OauthClient Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OauthClient(name: string, args: OauthClientArgs, opts?: CustomResourceOptions);
    @overload
def OauthClient(resource_name: str,
                args: OauthClientArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def OauthClient(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                redirect_uris: Optional[Sequence[str]] = None,
                token_endpoint_auth_method: Optional[str] = None,
                client_name: Optional[str] = None,
                account_id: Optional[str] = None,
                grant_types: Optional[Sequence[str]] = None,
                scopes: Optional[Sequence[str]] = None,
                response_types: Optional[Sequence[str]] = None,
                client_uri: Optional[str] = None,
                post_logout_redirect_uris: Optional[Sequence[str]] = None,
                policy_uri: Optional[str] = None,
                oauth_client_id: Optional[str] = None,
                logo_uri: Optional[str] = None,
                allowed_cors_origins: Optional[Sequence[str]] = None,
                tos_uri: Optional[str] = None,
                visibility: Optional[str] = None)
    func NewOauthClient(ctx *Context, name string, args OauthClientArgs, opts ...ResourceOption) (*OauthClient, error)
    public OauthClient(string name, OauthClientArgs args, CustomResourceOptions? opts = null)
    public OauthClient(String name, OauthClientArgs args)
public OauthClient(String name, OauthClientArgs args, CustomResourceOptions options)

    type: cloudflare:OauthClient
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "cloudflare_oauth_client" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args OauthClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OauthClientArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OauthClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OauthClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OauthClientArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var oauthClientResource = new Cloudflare.OauthClient("oauthClientResource", new()
{
    RedirectUris = new[]
    {
        "string",
    },
    TokenEndpointAuthMethod = "string",
    ClientName = "string",
    AccountId = "string",
    GrantTypes = new[]
    {
        "string",
    },
    Scopes = new[]
    {
        "string",
    },
    ResponseTypes = new[]
    {
        "string",
    },
    ClientUri = "string",
    PostLogoutRedirectUris = new[]
    {
        "string",
    },
    PolicyUri = "string",
    OauthClientId = "string",
    LogoUri = "string",
    AllowedCorsOrigins = new[]
    {
        "string",
    },
    TosUri = "string",
    Visibility = "string",
});

    example, err := cloudflare.NewOauthClient(ctx, "oauthClientResource", &cloudflare.OauthClientArgs{
	RedirectUris: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenEndpointAuthMethod: pulumi.String("string"),
	ClientName:              pulumi.String("string"),
	AccountId:               pulumi.String("string"),
	GrantTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResponseTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ClientUri: pulumi.String("string"),
	PostLogoutRedirectUris: pulumi.StringArray{
		pulumi.String("string"),
	},
	PolicyUri:     pulumi.String("string"),
	OauthClientId: pulumi.String("string"),
	LogoUri:       pulumi.String("string"),
	AllowedCorsOrigins: pulumi.StringArray{
		pulumi.String("string"),
	},
	TosUri:     pulumi.String("string"),
	Visibility: pulumi.String("string"),
})

    resource "cloudflare_oauth_client" "oauthClientResource" {
  lifecycle {
    create_before_destroy = true
  }
  redirect_uris              = ["string"]
  token_endpoint_auth_method = "string"
  client_name                = "string"
  account_id                 = "string"
  grant_types                = ["string"]
  scopes                     = ["string"]
  response_types             = ["string"]
  client_uri                 = "string"
  post_logout_redirect_uris  = ["string"]
  policy_uri                 = "string"
  oauth_client_id            = "string"
  logo_uri                   = "string"
  allowed_cors_origins       = ["string"]
  tos_uri                    = "string"
  visibility                 = "string"
}

    var oauthClientResource = new OauthClient("oauthClientResource", OauthClientArgs.builder()
    .redirectUris("string")
    .tokenEndpointAuthMethod("string")
    .clientName("string")
    .accountId("string")
    .grantTypes("string")
    .scopes("string")
    .responseTypes("string")
    .clientUri("string")
    .postLogoutRedirectUris("string")
    .policyUri("string")
    .oauthClientId("string")
    .logoUri("string")
    .allowedCorsOrigins("string")
    .tosUri("string")
    .visibility("string")
    .build());

    oauth_client_resource = cloudflare.OauthClient("oauthClientResource",
    redirect_uris=["string"],
    token_endpoint_auth_method="string",
    client_name="string",
    account_id="string",
    grant_types=["string"],
    scopes=["string"],
    response_types=["string"],
    client_uri="string",
    post_logout_redirect_uris=["string"],
    policy_uri="string",
    oauth_client_id="string",
    logo_uri="string",
    allowed_cors_origins=["string"],
    tos_uri="string",
    visibility="string")

    const oauthClientResource = new cloudflare.OauthClient("oauthClientResource", {
    redirectUris: ["string"],
    tokenEndpointAuthMethod: "string",
    clientName: "string",
    accountId: "string",
    grantTypes: ["string"],
    scopes: ["string"],
    responseTypes: ["string"],
    clientUri: "string",
    postLogoutRedirectUris: ["string"],
    policyUri: "string",
    oauthClientId: "string",
    logoUri: "string",
    allowedCorsOrigins: ["string"],
    tosUri: "string",
    visibility: "string",
});

    type: cloudflare:OauthClient
properties:
    accountId: string
    allowedCorsOrigins:
        - string
    clientName: string
    clientUri: string
    grantTypes:
        - string
    logoUri: string
    oauthClientId: string
    policyUri: string
    postLogoutRedirectUris:
        - string
    redirectUris:
        - string
    responseTypes:
        - string
    scopes:
        - string
    tokenEndpointAuthMethod: string
    tosUri: string
    visibility: string

    OauthClient Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OauthClient resource accepts the following input properties:

    AccountId string
    Account identifier tag.
    ClientName string
    Human-readable name of the OAuth client.
    GrantTypes List<string>
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    RedirectUris List<string>
    Array of allowed redirect URIs for the client.
    ResponseTypes List<string>
    Array of OAuth response types the client is allowed to use.
    Scopes List<string>
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    TokenEndpointAuthMethod string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    AllowedCorsOrigins List<string>
    Array of allowed CORS origins.
    ClientUri string
    URL of the home page of the client.
    LogoUri string
    URL of the client's logo.
    OauthClientId string
    The unique identifier for an OAuth client.
    PolicyUri string
    URL that points to a privacy policy document.
    PostLogoutRedirectUris List<string>
    Array of allowed post-logout redirect URIs.
    TosUri string
    URL that points to a terms of service document.
    Visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    AccountId string
    Account identifier tag.
    ClientName string
    Human-readable name of the OAuth client.
    GrantTypes []string
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    RedirectUris []string
    Array of allowed redirect URIs for the client.
    ResponseTypes []string
    Array of OAuth response types the client is allowed to use.
    Scopes []string
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    TokenEndpointAuthMethod string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    AllowedCorsOrigins []string
    Array of allowed CORS origins.
    ClientUri string
    URL of the home page of the client.
    LogoUri string
    URL of the client's logo.
    OauthClientId string
    The unique identifier for an OAuth client.
    PolicyUri string
    URL that points to a privacy policy document.
    PostLogoutRedirectUris []string
    Array of allowed post-logout redirect URIs.
    TosUri string
    URL that points to a terms of service document.
    Visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    account_id string
    Account identifier tag.
    client_name string
    Human-readable name of the OAuth client.
    grant_types list(string)
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    redirect_uris list(string)
    Array of allowed redirect URIs for the client.
    response_types list(string)
    Array of OAuth response types the client is allowed to use.
    scopes list(string)
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    token_endpoint_auth_method string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    allowed_cors_origins list(string)
    Array of allowed CORS origins.
    client_uri string
    URL of the home page of the client.
    logo_uri string
    URL of the client's logo.
    oauth_client_id string
    The unique identifier for an OAuth client.
    policy_uri string
    URL that points to a privacy policy document.
    post_logout_redirect_uris list(string)
    Array of allowed post-logout redirect URIs.
    tos_uri string
    URL that points to a terms of service document.
    visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    accountId String
    Account identifier tag.
    clientName String
    Human-readable name of the OAuth client.
    grantTypes List<String>
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    redirectUris List<String>
    Array of allowed redirect URIs for the client.
    responseTypes List<String>
    Array of OAuth response types the client is allowed to use.
    scopes List<String>
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    tokenEndpointAuthMethod String
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    allowedCorsOrigins List<String>
    Array of allowed CORS origins.
    clientUri String
    URL of the home page of the client.
    logoUri String
    URL of the client's logo.
    oauthClientId String
    The unique identifier for an OAuth client.
    policyUri String
    URL that points to a privacy policy document.
    postLogoutRedirectUris List<String>
    Array of allowed post-logout redirect URIs.
    tosUri String
    URL that points to a terms of service document.
    visibility String
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    accountId string
    Account identifier tag.
    clientName string
    Human-readable name of the OAuth client.
    grantTypes string[]
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    redirectUris string[]
    Array of allowed redirect URIs for the client.
    responseTypes string[]
    Array of OAuth response types the client is allowed to use.
    scopes string[]
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    tokenEndpointAuthMethod string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    allowedCorsOrigins string[]
    Array of allowed CORS origins.
    clientUri string
    URL of the home page of the client.
    logoUri string
    URL of the client's logo.
    oauthClientId string
    The unique identifier for an OAuth client.
    policyUri string
    URL that points to a privacy policy document.
    postLogoutRedirectUris string[]
    Array of allowed post-logout redirect URIs.
    tosUri string
    URL that points to a terms of service document.
    visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    account_id str
    Account identifier tag.
    client_name str
    Human-readable name of the OAuth client.
    grant_types Sequence[str]
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    redirect_uris Sequence[str]
    Array of allowed redirect URIs for the client.
    response_types Sequence[str]
    Array of OAuth response types the client is allowed to use.
    scopes Sequence[str]
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    token_endpoint_auth_method str
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    allowed_cors_origins Sequence[str]
    Array of allowed CORS origins.
    client_uri str
    URL of the home page of the client.
    logo_uri str
    URL of the client's logo.
    oauth_client_id str
    The unique identifier for an OAuth client.
    policy_uri str
    URL that points to a privacy policy document.
    post_logout_redirect_uris Sequence[str]
    Array of allowed post-logout redirect URIs.
    tos_uri str
    URL that points to a terms of service document.
    visibility str
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    accountId String
    Account identifier tag.
    clientName String
    Human-readable name of the OAuth client.
    grantTypes List<String>
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    redirectUris List<String>
    Array of allowed redirect URIs for the client.
    responseTypes List<String>
    Array of OAuth response types the client is allowed to use.
    scopes List<String>
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    tokenEndpointAuthMethod String
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    allowedCorsOrigins List<String>
    Array of allowed CORS origins.
    clientUri String
    URL of the home page of the client.
    logoUri String
    URL of the client's logo.
    oauthClientId String
    The unique identifier for an OAuth client.
    policyUri String
    URL that points to a privacy policy document.
    postLogoutRedirectUris List<String>
    Array of allowed post-logout redirect URIs.
    tosUri String
    URL that points to a terms of service document.
    visibility String
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OauthClient resource produces the following output properties:

    ClientId string
    The unique identifier for an OAuth client.
    ClientSecret string
    The client secret. This is the only time the secret is returned in a response.
    ClientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    CreatedAt string
    Timestamp when the OAuth client was created.
    HasRotatedSecret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    PromotedAt string
    Timestamp when the OAuth client was promoted to public visibility.
    UpdatedAt string
    Timestamp when the OAuth client was last updated.
    ClientId string
    The unique identifier for an OAuth client.
    ClientSecret string
    The client secret. This is the only time the secret is returned in a response.
    ClientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    CreatedAt string
    Timestamp when the OAuth client was created.
    HasRotatedSecret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    PromotedAt string
    Timestamp when the OAuth client was promoted to public visibility.
    UpdatedAt string
    Timestamp when the OAuth client was last updated.
    client_id string
    The unique identifier for an OAuth client.
    client_secret string
    The client secret. This is the only time the secret is returned in a response.
    client_uri_verification object
    Client URI domain control verification state.
    created_at string
    Timestamp when the OAuth client was created.
    has_rotated_secret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    string
    Timestamp when the OAuth client was promoted to public visibility.
    updated_at string
    Timestamp when the OAuth client was last updated.
    clientId String
    The unique identifier for an OAuth client.
    clientSecret String
    The client secret. This is the only time the secret is returned in a response.
    clientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    createdAt String
    Timestamp when the OAuth client was created.
    hasRotatedSecret Boolean
    Indicates whether the client has a rotated secret that has not yet been deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    promotedAt String
    Timestamp when the OAuth client was promoted to public visibility.
    updatedAt String
    Timestamp when the OAuth client was last updated.
    clientId string
    The unique identifier for an OAuth client.
    clientSecret string
    The client secret. This is the only time the secret is returned in a response.
    clientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    createdAt string
    Timestamp when the OAuth client was created.
    hasRotatedSecret boolean
    Indicates whether the client has a rotated secret that has not yet been deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    promotedAt string
    Timestamp when the OAuth client was promoted to public visibility.
    updatedAt string
    Timestamp when the OAuth client was last updated.
    client_id str
    The unique identifier for an OAuth client.
    client_secret str
    The client secret. This is the only time the secret is returned in a response.
    client_uri_verification OauthClientClientUriVerification
    Client URI domain control verification state.
    created_at str
    Timestamp when the OAuth client was created.
    has_rotated_secret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    id str
    The provider-assigned unique ID for this managed resource.
    str
    Timestamp when the OAuth client was promoted to public visibility.
    updated_at str
    Timestamp when the OAuth client was last updated.
    clientId String
    The unique identifier for an OAuth client.
    clientSecret String
    The client secret. This is the only time the secret is returned in a response.
    clientUriVerification Property Map
    Client URI domain control verification state.
    createdAt String
    Timestamp when the OAuth client was created.
    hasRotatedSecret Boolean
    Indicates whether the client has a rotated secret that has not yet been deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    promotedAt String
    Timestamp when the OAuth client was promoted to public visibility.
    updatedAt String
    Timestamp when the OAuth client was last updated.

    Look up Existing OauthClient Resource

    Get an existing OauthClient resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OauthClientState, opts?: CustomResourceOptions): OauthClient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allowed_cors_origins: Optional[Sequence[str]] = None,
        client_id: Optional[str] = None,
        client_name: Optional[str] = None,
        client_secret: Optional[str] = None,
        client_uri: Optional[str] = None,
        client_uri_verification: Optional[OauthClientClientUriVerificationArgs] = None,
        created_at: Optional[str] = None,
        grant_types: Optional[Sequence[str]] = None,
        has_rotated_secret: Optional[bool] = None,
        logo_uri: Optional[str] = None,
        oauth_client_id: Optional[str] = None,
        policy_uri: Optional[str] = None,
        post_logout_redirect_uris: Optional[Sequence[str]] = None,
        promoted_at: Optional[str] = None,
        redirect_uris: Optional[Sequence[str]] = None,
        response_types: Optional[Sequence[str]] = None,
        scopes: Optional[Sequence[str]] = None,
        token_endpoint_auth_method: Optional[str] = None,
        tos_uri: Optional[str] = None,
        updated_at: Optional[str] = None,
        visibility: Optional[str] = None) -> OauthClient
    func GetOauthClient(ctx *Context, name string, id IDInput, state *OauthClientState, opts ...ResourceOption) (*OauthClient, error)
    public static OauthClient Get(string name, Input<string> id, OauthClientState? state, CustomResourceOptions? opts = null)
    public static OauthClient get(String name, Output<String> id, OauthClientState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:OauthClient    get:      id: ${id}
    import {
  to = cloudflare_oauth_client.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Account identifier tag.
    AllowedCorsOrigins List<string>
    Array of allowed CORS origins.
    ClientId string
    The unique identifier for an OAuth client.
    ClientName string
    Human-readable name of the OAuth client.
    ClientSecret string
    The client secret. This is the only time the secret is returned in a response.
    ClientUri string
    URL of the home page of the client.
    ClientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    CreatedAt string
    Timestamp when the OAuth client was created.
    GrantTypes List<string>
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    HasRotatedSecret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    LogoUri string
    URL of the client's logo.
    OauthClientId string
    The unique identifier for an OAuth client.
    PolicyUri string
    URL that points to a privacy policy document.
    PostLogoutRedirectUris List<string>
    Array of allowed post-logout redirect URIs.
    PromotedAt string
    Timestamp when the OAuth client was promoted to public visibility.
    RedirectUris List<string>
    Array of allowed redirect URIs for the client.
    ResponseTypes List<string>
    Array of OAuth response types the client is allowed to use.
    Scopes List<string>
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    TokenEndpointAuthMethod string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    TosUri string
    URL that points to a terms of service document.
    UpdatedAt string
    Timestamp when the OAuth client was last updated.
    Visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    AccountId string
    Account identifier tag.
    AllowedCorsOrigins []string
    Array of allowed CORS origins.
    ClientId string
    The unique identifier for an OAuth client.
    ClientName string
    Human-readable name of the OAuth client.
    ClientSecret string
    The client secret. This is the only time the secret is returned in a response.
    ClientUri string
    URL of the home page of the client.
    ClientUriVerification OauthClientClientUriVerificationArgs
    Client URI domain control verification state.
    CreatedAt string
    Timestamp when the OAuth client was created.
    GrantTypes []string
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    HasRotatedSecret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    LogoUri string
    URL of the client's logo.
    OauthClientId string
    The unique identifier for an OAuth client.
    PolicyUri string
    URL that points to a privacy policy document.
    PostLogoutRedirectUris []string
    Array of allowed post-logout redirect URIs.
    PromotedAt string
    Timestamp when the OAuth client was promoted to public visibility.
    RedirectUris []string
    Array of allowed redirect URIs for the client.
    ResponseTypes []string
    Array of OAuth response types the client is allowed to use.
    Scopes []string
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    TokenEndpointAuthMethod string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    TosUri string
    URL that points to a terms of service document.
    UpdatedAt string
    Timestamp when the OAuth client was last updated.
    Visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    account_id string
    Account identifier tag.
    allowed_cors_origins list(string)
    Array of allowed CORS origins.
    client_id string
    The unique identifier for an OAuth client.
    client_name string
    Human-readable name of the OAuth client.
    client_secret string
    The client secret. This is the only time the secret is returned in a response.
    client_uri string
    URL of the home page of the client.
    client_uri_verification object
    Client URI domain control verification state.
    created_at string
    Timestamp when the OAuth client was created.
    grant_types list(string)
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    has_rotated_secret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    logo_uri string
    URL of the client's logo.
    oauth_client_id string
    The unique identifier for an OAuth client.
    policy_uri string
    URL that points to a privacy policy document.
    post_logout_redirect_uris list(string)
    Array of allowed post-logout redirect URIs.
    promoted_at string
    Timestamp when the OAuth client was promoted to public visibility.
    redirect_uris list(string)
    Array of allowed redirect URIs for the client.
    response_types list(string)
    Array of OAuth response types the client is allowed to use.
    scopes list(string)
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    token_endpoint_auth_method string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    tos_uri string
    URL that points to a terms of service document.
    updated_at string
    Timestamp when the OAuth client was last updated.
    visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    accountId String
    Account identifier tag.
    allowedCorsOrigins List<String>
    Array of allowed CORS origins.
    clientId String
    The unique identifier for an OAuth client.
    clientName String
    Human-readable name of the OAuth client.
    clientSecret String
    The client secret. This is the only time the secret is returned in a response.
    clientUri String
    URL of the home page of the client.
    clientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    createdAt String
    Timestamp when the OAuth client was created.
    grantTypes List<String>
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    hasRotatedSecret Boolean
    Indicates whether the client has a rotated secret that has not yet been deleted.
    logoUri String
    URL of the client's logo.
    oauthClientId String
    The unique identifier for an OAuth client.
    policyUri String
    URL that points to a privacy policy document.
    postLogoutRedirectUris List<String>
    Array of allowed post-logout redirect URIs.
    promotedAt String
    Timestamp when the OAuth client was promoted to public visibility.
    redirectUris List<String>
    Array of allowed redirect URIs for the client.
    responseTypes List<String>
    Array of OAuth response types the client is allowed to use.
    scopes List<String>
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    tokenEndpointAuthMethod String
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    tosUri String
    URL that points to a terms of service document.
    updatedAt String
    Timestamp when the OAuth client was last updated.
    visibility String
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    accountId string
    Account identifier tag.
    allowedCorsOrigins string[]
    Array of allowed CORS origins.
    clientId string
    The unique identifier for an OAuth client.
    clientName string
    Human-readable name of the OAuth client.
    clientSecret string
    The client secret. This is the only time the secret is returned in a response.
    clientUri string
    URL of the home page of the client.
    clientUriVerification OauthClientClientUriVerification
    Client URI domain control verification state.
    createdAt string
    Timestamp when the OAuth client was created.
    grantTypes string[]
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    hasRotatedSecret boolean
    Indicates whether the client has a rotated secret that has not yet been deleted.
    logoUri string
    URL of the client's logo.
    oauthClientId string
    The unique identifier for an OAuth client.
    policyUri string
    URL that points to a privacy policy document.
    postLogoutRedirectUris string[]
    Array of allowed post-logout redirect URIs.
    promotedAt string
    Timestamp when the OAuth client was promoted to public visibility.
    redirectUris string[]
    Array of allowed redirect URIs for the client.
    responseTypes string[]
    Array of OAuth response types the client is allowed to use.
    scopes string[]
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    tokenEndpointAuthMethod string
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    tosUri string
    URL that points to a terms of service document.
    updatedAt string
    Timestamp when the OAuth client was last updated.
    visibility string
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    account_id str
    Account identifier tag.
    allowed_cors_origins Sequence[str]
    Array of allowed CORS origins.
    client_id str
    The unique identifier for an OAuth client.
    client_name str
    Human-readable name of the OAuth client.
    client_secret str
    The client secret. This is the only time the secret is returned in a response.
    client_uri str
    URL of the home page of the client.
    client_uri_verification OauthClientClientUriVerificationArgs
    Client URI domain control verification state.
    created_at str
    Timestamp when the OAuth client was created.
    grant_types Sequence[str]
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    has_rotated_secret bool
    Indicates whether the client has a rotated secret that has not yet been deleted.
    logo_uri str
    URL of the client's logo.
    oauth_client_id str
    The unique identifier for an OAuth client.
    policy_uri str
    URL that points to a privacy policy document.
    post_logout_redirect_uris Sequence[str]
    Array of allowed post-logout redirect URIs.
    promoted_at str
    Timestamp when the OAuth client was promoted to public visibility.
    redirect_uris Sequence[str]
    Array of allowed redirect URIs for the client.
    response_types Sequence[str]
    Array of OAuth response types the client is allowed to use.
    scopes Sequence[str]
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    token_endpoint_auth_method str
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    tos_uri str
    URL that points to a terms of service document.
    updated_at str
    Timestamp when the OAuth client was last updated.
    visibility str
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".
    accountId String
    Account identifier tag.
    allowedCorsOrigins List<String>
    Array of allowed CORS origins.
    clientId String
    The unique identifier for an OAuth client.
    clientName String
    Human-readable name of the OAuth client.
    clientSecret String
    The client secret. This is the only time the secret is returned in a response.
    clientUri String
    URL of the home page of the client.
    clientUriVerification Property Map
    Client URI domain control verification state.
    createdAt String
    Timestamp when the OAuth client was created.
    grantTypes List<String>
    Array of OAuth grant types the client is allowed to use. authorizationCode is required; refreshToken may be included optionally.
    hasRotatedSecret Boolean
    Indicates whether the client has a rotated secret that has not yet been deleted.
    logoUri String
    URL of the client's logo.
    oauthClientId String
    The unique identifier for an OAuth client.
    policyUri String
    URL that points to a privacy policy document.
    postLogoutRedirectUris List<String>
    Array of allowed post-logout redirect URIs.
    promotedAt String
    Timestamp when the OAuth client was promoted to public visibility.
    redirectUris List<String>
    Array of allowed redirect URIs for the client.
    responseTypes List<String>
    Array of OAuth response types the client is allowed to use.
    scopes List<String>
    Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offlineAccess and openid are added or removed automatically based on grantTypes and responseTypes.
    tokenEndpointAuthMethod String
    The authentication method the client uses at the token endpoint. Available values: "none", "clientsecretbasic", "clientsecretpost".
    tosUri String
    URL that points to a terms of service document.
    updatedAt String
    Timestamp when the OAuth client was last updated.
    visibility String
    Promote the OAuth client from private to public visibility. Only public is accepted; demotion to private is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. Available values: "public".

    Supporting Types

    OauthClientClientUriVerification, OauthClientClientUriVerificationArgs

    Status string
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    Text string
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.
    Status string
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    Text string
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.
    status string
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    text string
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.
    status String
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    text String
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.
    status string
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    text string
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.
    status str
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    text str
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.
    status String
    Current verification status for the client URI host. Available values: "pending", "inProgress", "verified", "failed".
    text String
    Exact TXT record value that must be added to DNS to prove ownership of the client URI host.

    Import

    This resource does not currently support pulumi import.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.18.0
    published on Thursday, Jul 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial