/gateway-create-producer-ping

post

https://api.akeyless.io/gateway-create-producer-ping

Body Params

delete_protection

string

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

item-custom-fields

object

Additional custom fields to associate with the item

json

boolean

Defaults to false

Set output format to JSON

name

string

required

Dynamic secret name

ping-administrative-port

string

Defaults to 9999

Ping Federate administrative port

ping-atm-id

string

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-port

string

Defaults to 9031

Ping Federate authorization port

ping-cert-subject-dn

string

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-type

string

Defaults to CLIENT_SECRET

OAuth Client Authentication Type [CLIENT_SECRET, PRIVATE_KEY_JWT, CLIENT_TLS_CERTIFICATE]

ping-enforce-replay-prevention

string

Defaults to false

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-types

array of strings

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-grant-types

ping-issuer-dn

string

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-jwks

string

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-url

string

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-password

string

Ping Federate privileged user password

ping-privileged-user

string

Ping Federate privileged user

ping-redirect-uris

array of strings

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-redirect-uris

ping-restricted-scopes

array of strings

Limit the OAuth client to specific scopes list

ping-restricted-scopes

ping-signing-algo

string

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-url

string

Ping URL

producer-encryption-key-name

string

Dynamic producer encryption key

201gatewayCreateProducerPingResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.