v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/gateway-create-producer-ping

Request body

delete_protectionstring

Protection from accidental deletion of this object [true/false]

input-rulestring[]

Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) Mirrors commands.AgenticRulesParams — kept separate because ResourceDS cannot embed it (different package, different struct layout).

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

namestring required

Dynamic secret name

output-rulestring[]

Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)

ping-administrative-portstring

Ping Federate administrative port

ping-atm-idstring

Set a specific Access Token Management (ATM) instance for the created OAuth Client by providing the ATM Id. If no explicit value is given, the default pingfederate server ATM will be set.

ping-authorization-portstring

Ping Federate authorization port

ping-cert-subject-dnstring

The subject DN of the client certificate. If no explicit value is given, the producer will create CA certificate and matched client certificate and return it as value. Used in conjunction with ping-issuer-dn (relevant for CLIENT_TLS_CERTIFICATE authentication method)

ping-client-authentication-typestring

OAuth Client Authentication Type [CLIENT_SECRET, PRIVATE_KEY_JWT, CLIENT_TLS_CERTIFICATE]

ping-enforce-replay-preventionstring

Determines whether PingFederate requires a unique signed JWT from the client for each action (relevant for PRIVATE_KEY_JWT authentication method) [true/false]

ping-grant-typesstring[]

List of OAuth client grant types [IMPLICIT, AUTHORIZATION_CODE, CLIENT_CREDENTIALS, TOKEN_EXCHANGE, REFRESH_TOKEN, ASSERTION_GRANTS, PASSWORD, RESOURCE_OWNER_CREDENTIALS]. If no explicit value is given, AUTHORIZATION_CODE will be selected as default.

ping-issuer-dnstring

Issuer DN of trusted CA certificate that imported into Ping Federate server. You may select "Trust Any" to trust all the existing issuers in Ping Federate server. Used in conjunction with ping-cert-subject-dn (relevant for CLIENT_TLS_CERTIFICATE authentication method)

ping-jwksstring

Base64-encoded JSON Web Key Set (JWKS). If no explicit value is given, the producer will create JWKs and matched signed JWT (Sign Algo: RS256) and return it as value (relevant for PRIVATE_KEY_JWT authentication method)

ping-jwks-urlstring

The URL of the JSON Web Key Set (JWKS). If no explicit value is given, the producer will create JWKs and matched signed JWT and return it as value (relevant for PRIVATE_KEY_JWT authentication method)

ping-passwordstring

Ping Federate privileged user password

ping-privileged-userstring

Ping Federate privileged user

ping-redirect-urisstring[]

List of URIs to which the OAuth authorization server may redirect the resource owner's user agent after authorization is obtained. At least one redirection URI is required for the AUTHORIZATION_CODE and IMPLICIT grant types.

ping-restricted-scopesstring[]

Limit the OAuth client to specific scopes list

ping-signing-algostring

The signing algorithm that the client must use to sign its request objects [RS256,RS384,RS512,ES256,ES384,ES512,PS256,PS384,PS512] If no explicit value is given, the client can use any of the supported signing algorithms (relevant for PRIVATE_KEY_JWT authentication method)

ping-urlstring

Ping URL

producer-encryption-key-namestring

Dynamic producer encryption key

tagsstring[]

Add tags attached to this object

target-namestring

Target name

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

user-ttlstring

The time from dynamic secret creation to expiration.

Response

gatewayCreateProducerPingResponse wraps response body.