Waiting for engine...
Skip to main content

EventStreamsToken

Represents Event Streams environment token including jwt token, configurable consume/produce permissions, expiration setting and additional full lifecycle management attributes.

type EventStreamsToken {
id: ID!
name: String
data: String!
allowConsume: Boolean!
allowProduce: Boolean!
expirationEditable: Boolean!
expirationTime: DateTime!
createdTime: DateTime!
createdBy: String
description: String
}

Fields​

EventStreamsToken.id ● ID! non-null scalar miscellaneous {#id}

Unique identifier associated with a token

EventStreamsToken.name ● String scalar miscellaneous {#name}

The name of a token chosen by the user during creation. The name would be set to 'default', the default value when the token is auto-created for an environment.

EventStreamsToken.data ● String! non-null scalar miscellaneous {#data}

The actual JWT token associated with the object

EventStreamsToken.allowConsume ● Boolean! non-null scalar miscellaneous {#allow-consume}

Determines if consume action permission was granted to the token or not.

EventStreamsToken.allowProduce ● Boolean! non-null scalar miscellaneous {#allow-produce}

Determines if produce action permission was granted to the token or not.

EventStreamsToken.expirationEditable ● Boolean! non-null scalar miscellaneous {#expiration-editable}

Signifies if the expiration time of the token can be extended without having to recreate a token. The legacy tokens will have this set to false since the token carries the expirationTs as a claim within itself.

EventStreamsToken.expirationTime ● DateTime! non-null scalar platform {#expiration-time}

Timestamp by which a token would expire.365 days from the creation date if not specified.

EventStreamsToken.createdTime ● DateTime! non-null scalar platform {#created-time}

Timestamp of when the token was created.

EventStreamsToken.createdBy ● String scalar miscellaneous {#created-by}

The user who created the token.

EventStreamsToken.description ● String scalar miscellaneous {#description}

The description associated with a token

Returned By​

eventStreamsTokenCreate mutation ●  eventStreamsTokenUpdate mutation

Member Of​

EventStreamsEnvironment object

On this Page