Condividi tramite


SubscriptionCreateParameters interface

Dettagli della creazione della sottoscrizione.

Proprietà

allowTracing

Determina se è possibile abilitare la traccia

displayName

Nome sottoscrizione.

ownerId

Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId}

primaryKey

Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.

scope

Ambito come /products/{productId} o /apis o /apis/{apiId}.

secondaryKey

Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.

state

Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

Dettagli proprietà

allowTracing

Determina se è possibile abilitare la traccia

allowTracing?: boolean

Valore della proprietà

boolean

displayName

Nome sottoscrizione.

displayName?: string

Valore della proprietà

string

ownerId

Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId}

ownerId?: string

Valore della proprietà

string

primaryKey

Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.

primaryKey?: string

Valore della proprietà

string

scope

Ambito come /products/{productId} o /apis o /apis/{apiId}.

scope?: string

Valore della proprietà

string

secondaryKey

Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.

secondaryKey?: string

Valore della proprietà

string

state

Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

state?: SubscriptionState

Valore della proprietà