SubscriptionCreateParameters interface
Az előfizetés létrehozási részletei.
Tulajdonságok
| allow |
Meghatározza, hogy engedélyezhető-e a nyomkövetés |
| display |
Előfizetés neve. |
| owner |
Felhasználó (felhasználói azonosító elérési útja), akinek az előfizetését a /users/{userId} űrlapon hozza létre |
| primary |
Elsődleges előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot. |
| scope | Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}. |
| secondary |
Másodlagos előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot. |
| state | Kezdeti előfizetési állapot. Ha nincs megadva érték, az előfizetés Elküldve állapottal jön létre. Lehetséges állapotok * aktívak – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * benyújtotta – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda tagadta meg, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta. |
Tulajdonság adatai
allowTracing
Meghatározza, hogy engedélyezhető-e a nyomkövetés
allowTracing?: boolean
Tulajdonság értéke
boolean
displayName
Előfizetés neve.
displayName?: string
Tulajdonság értéke
string
ownerId
Felhasználó (felhasználói azonosító elérési útja), akinek az előfizetését a /users/{userId} űrlapon hozza létre
ownerId?: string
Tulajdonság értéke
string
primaryKey
Elsődleges előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot.
primaryKey?: string
Tulajdonság értéke
string
scope
Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}.
scope?: string
Tulajdonság értéke
string
secondaryKey
Másodlagos előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot.
secondaryKey?: string
Tulajdonság értéke
string
state
Kezdeti előfizetési állapot. Ha nincs megadva érték, az előfizetés Elküldve állapottal jön létre. Lehetséges állapotok * aktívak – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * benyújtotta – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda tagadta meg, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.
state?: SubscriptionState