oauth_clients

Creates, updates, deletes, gets or lists an oauth_clients resource.

Overview

Name	oauth_clients
Type	Resource
Id	firebase.appcheck.oauth_clients

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
exchange_debug_token	exec	oauthClientsId		Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.
generate_app_attest_challenge	exec	oauthClientsId		Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.
exchange_app_attest_attestation	exec	oauthClientsId		Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful).
exchange_app_attest_assertion	exec	oauthClientsId		Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
oauthClientsId	string

Lifecycle Methods

exchange_debug_token

Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.

EXEC firebase.appcheck.oauth_clients.exchange_debug_token 
@oauthClientsId='{{ oauthClientsId }}' --required 
@@json=
'{
"debugToken": "{{ debugToken }}", 
"limitedUse": {{ limitedUse }}
}';

generate_app_attest_challenge

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

EXEC firebase.appcheck.oauth_clients.generate_app_attest_challenge 
@oauthClientsId='{{ oauthClientsId }}' --required;

exchange_app_attest_attestation

Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful).

EXEC firebase.appcheck.oauth_clients.exchange_app_attest_attestation 
@oauthClientsId='{{ oauthClientsId }}' --required 
@@json=
'{
"attestationStatement": "{{ attestationStatement }}", 
"challenge": "{{ challenge }}", 
"keyId": "{{ keyId }}", 
"limitedUse": {{ limitedUse }}
}';

exchange_app_attest_assertion

Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.

EXEC firebase.appcheck.oauth_clients.exchange_app_attest_assertion 
@oauthClientsId='{{ oauthClientsId }}' --required 
@@json=
'{
"artifact": "{{ artifact }}", 
"assertion": "{{ assertion }}", 
"challenge": "{{ challenge }}", 
"limitedUse": {{ limitedUse }}
}';