--- title: Shared --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Shared ##### ModelsExpand Collapse type ASN int64 [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20asn%20%3E%20(schema)>)
type AuditLog struct{…} ID stringOptional A string that uniquely identifies the audit log. Link to this property
Action AuditLogActionOptional Result boolOptional A boolean that indicates if the action attempted was successful. Link to this property Type stringOptional A short string that describes the action that was performed. Link to this property
Link to this property
Actor AuditLogActorOptional ID stringOptional The ID of the actor that performed the action. If a user performed the action, this will be their User ID. Link to this property Email stringOptional The email of the user that performed the action. formatemail Link to this property IP stringOptional The IP address of the request that performed the action. Link to this property
Type AuditLogActorTypeOptional The type of actor, whether a User, Cloudflare Admin, or an Automated System. One of the following: const AuditLogActorTypeUser AuditLogActorType = "user" Link to this property const AuditLogActorTypeAdmin AuditLogActorType = "admin" Link to this property const AuditLogActorTypeCloudflare AuditLogActorType = "Cloudflare" Link to this property
Link to this property
Link to this property Interface stringOptional The source of the event. Link to this property Metadata unknownOptional An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. Link to this property NewValue stringOptional The new value of the resource that was modified. Link to this property OldValue stringOptional The value of the resource before it was modified. Link to this property
Owner AuditLogOwnerOptional ID stringOptional Identifier maxLength32 Link to this property
Link to this property
Resource AuditLogResourceOptional ID stringOptional An identifier for the resource that was affected by the action. Link to this property Type stringOptional A short string that describes the resource that was affected by the action. Link to this property
Link to this property When TimeOptional A UTC RFC3339 timestamp that specifies when the action being logged occured. formatdate-time Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20audit_log%20%3E%20(schema)>)
type CertificateCA string The Certificate Authority that will issue the certificate. One of the following: const CertificateCADigicert CertificateCA = "digicert" Link to this property const CertificateCAGoogle CertificateCA = "google" Link to this property const CertificateCALetsEncrypt CertificateCA = "lets\_encrypt" Link to this property const CertificateCASSLCom CertificateCA = "ssl\_com" Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20certificate_ca%20%3E%20(schema)>)
type CertificateRequestType string Signature type desired on certificate (“origin-rsa” (rsa), “origin-ecc” (ecdsa), or “keyless-certificate” (for Keyless SSL servers). One of the following: const CertificateRequestTypeOriginRSA CertificateRequestType = "origin-rsa" Link to this property const CertificateRequestTypeOriginECC CertificateRequestType = "origin-ecc" Link to this property const CertificateRequestTypeKeylessCertificate CertificateRequestType = "keyless-certificate" Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20certificate_request_type%20%3E%20(schema)>)
type CloudflareTunnel struct{…} A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. ID stringOptional UUID of the tunnel. formatuuid maxLength36 Link to this property AccountTag stringOptional Cloudflare account ID maxLength32 Link to this property
ConfigSrc CloudflareTunnelConfigSrcOptional Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel on the Zero Trust dashboard. One of the following: const CloudflareTunnelConfigSrcLocal CloudflareTunnelConfigSrc = "local" Link to this property const CloudflareTunnelConfigSrcCloudflare CloudflareTunnelConfigSrc = "cloudflare" Link to this property
Link to this property
DeprecatedConnections \[]CloudflareTunnelConnectionOptional This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. ID stringOptional UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property ClientID stringOptional UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property ClientVersion stringOptional The cloudflared version used to establish this connection. Link to this property ColoName stringOptional The Cloudflare data center used for this connection. Link to this property DeprecatedIsPendingReconnect boolOptional This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property OpenedAt TimeOptional Timestamp of when the connection was established. formatdate-time Link to this property OriginIP stringOptional The public IP address of the host running cloudflared. Link to this property UUID stringOptional UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property ConnsActiveAt TimeOptional Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property ConnsInactiveAt TimeOptional Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property CreatedAt TimeOptional Timestamp of when the resource was created. formatdate-time Link to this property DeletedAt TimeOptional Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property Metadata unknownOptional Metadata associated with the tunnel. Link to this property Name stringOptional A user-friendly name for a tunnel. Link to this property DeprecatedRemoteConfig boolOptional Use the config\_src field instead. If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine. Link to this property
Status CloudflareTunnelStatusOptional The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: const CloudflareTunnelStatusInactive CloudflareTunnelStatus = "inactive" Link to this property const CloudflareTunnelStatusDegraded CloudflareTunnelStatus = "degraded" Link to this property const CloudflareTunnelStatusHealthy CloudflareTunnelStatus = "healthy" Link to this property const CloudflareTunnelStatusDown CloudflareTunnelStatus = "down" Link to this property
Link to this property
TunType CloudflareTunnelTunTypeOptional The type of tunnel. One of the following: const CloudflareTunnelTunTypeCfdTunnel CloudflareTunnelTunType = "cfd\_tunnel" Link to this property const CloudflareTunnelTunTypeWARPConnector CloudflareTunnelTunType = "warp\_connector" Link to this property const CloudflareTunnelTunTypeWARP CloudflareTunnelTunType = "warp" Link to this property const CloudflareTunnelTunTypeMagic CloudflareTunnelTunType = "magic" Link to this property const CloudflareTunnelTunTypeIPSec CloudflareTunnelTunType = "ip\_sec" Link to this property const CloudflareTunnelTunTypeGRE CloudflareTunnelTunType = "gre" Link to this property const CloudflareTunnelTunTypeCNI CloudflareTunnelTunType = "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20cloudflare_tunnel%20%3E%20(schema)>)
type ErrorData struct{…} Code int64Optional Link to this property DocumentationURL stringOptional Link to this property Message stringOptional Link to this property
Source ErrorDataSourceOptional Pointer stringOptional Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20error_data%20%3E%20(schema)>)
type Identifier struct{…} ID stringOptional The unique identifier for a certificate\_pack. Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20identifier%20%3E%20(schema)>)
type LoadBalancerPreview struct{…} Pools map\[string, string]Optional Monitored pool IDs mapped to their respective names. Link to this property PreviewID stringOptional Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20load_balancer_preview%20%3E%20(schema)>)
type Member struct{…} ID stringOptional Membership identifier tag. maxLength32 Link to this property Email stringOptional The contact email address of the user. maxLength90 Link to this property
Policies \[]MemberPolicyOptional Access policy for the membership ID stringOptional Policy identifier. Link to this property
Access MemberPoliciesAccessOptional Allow or deny operations against the resources. One of the following: const MemberPoliciesAccessAllow MemberPoliciesAccess = "allow" Link to this property const MemberPoliciesAccessDeny MemberPoliciesAccess = "deny" Link to this property
Link to this property
PermissionGroups \[]MemberPoliciesPermissionGroupOptional A set of permission groups that are specified to the policy. ID string Identifier of the permission group. Link to this property
Meta MemberPoliciesPermissionGroupsMetaOptional Attributes associated to the permission group. Category stringOptional A category used to group permission groups. Link to this property Deprecated stringOptional Indicates whether the permission group is deprecated. Link to this property Description stringOptional Additional information about the permission group. Link to this property Editable stringOptional Indicates whether the permission group can be edited. Link to this property EolAt TimeOptional The planned end-of-life date and time, when provided. formatdate-time Link to this property Label stringOptional A label identifying the permission group. Link to this property Scopes stringOptional The scope associated with the permission group. Link to this property Visibility stringOptional Indicates the permission group’s availability or visibility. Link to this property
Link to this property Name stringOptional Name of the permission group. Link to this property
Link to this property
ResourceGroups \[]MemberPoliciesResourceGroupOptional A list of resource groups that the policy applies to. ID string Identifier of the resource group. Link to this property
Scope MemberPoliciesResourceGroupsScope A scope is a combination of scope objects which provides additional context. Key string This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property
Objects \[]MemberPoliciesResourceGroupsScopeObject A list of scope objects for additional context. Key string This is a combination of pre-defined resource name and identifier (like Zone ID etc.) Link to this property
Link to this property
Link to this property
Meta MemberPoliciesResourceGroupsMetaOptional Attributes associated to the resource group. Key stringOptional Link to this property Value stringOptional Link to this property
Link to this property Name stringOptional Name of the resource group. Link to this property
Link to this property
Link to this property
Roles \[]RoleOptional Roles assigned to this Member. ID string Role identifier tag. maxLength32 Link to this property Description string Description of role’s permissions. Link to this property Name string Role name. maxLength120 Link to this property
Permissions RolePermissions Analytics PermissionGrantOptional Link to this property Billing PermissionGrantOptional Link to this property CachePurge PermissionGrantOptional Link to this property DNS PermissionGrantOptional Link to this property DNSRecords PermissionGrantOptional Link to this property LB PermissionGrantOptional Link to this property Logs PermissionGrantOptional Link to this property Organization PermissionGrantOptional Link to this property SSL PermissionGrantOptional Link to this property WAF PermissionGrantOptional Link to this property ZoneSettings PermissionGrantOptional Link to this property Zones PermissionGrantOptional Link to this property
Link to this property
Link to this property
Status MemberStatusOptional A member’s status in the account. One of the following: const MemberStatusAccepted MemberStatus = "accepted" Link to this property const MemberStatusPending MemberStatus = "pending" Link to this property
Link to this property
User MemberUserOptional Details of the user associated to the membership. Email string The contact email address of the user. maxLength90 Link to this property ID stringOptional Identifier maxLength32 minLength32 Link to this property FirstName stringOptional User’s first name maxLength60 Link to this property LastName stringOptional User’s last name maxLength60 Link to this property TwoFactorAuthenticationEnabled boolOptional Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20member%20%3E%20(schema)>)
type PaginationInfo struct{…} Count float64Optional Total number of results for the requested service Link to this property Page float64Optional Current page within paginated list of results Link to this property PerPage float64Optional Number of results per page of results Link to this property TotalCount float64Optional Total results available without any search parameters Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20pagination_info%20%3E%20(schema)>) type Permission string [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20permission%20%3E%20(schema)>)
type PermissionGrant struct{…} Read boolOptional Link to this property Write boolOptional Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20permission_grant%20%3E%20(schema)>)
type RatePlan struct{…} The rate plan applied to the subscription.
ID RatePlanIDOptional The ID of the rate plan. One of the following: const RatePlanIDFree RatePlanID = "free" Link to this property const RatePlanIDLite RatePlanID = "lite" Link to this property const RatePlanIDPro RatePlanID = "pro" Link to this property const RatePlanIDProPlus RatePlanID = "pro\_plus" Link to this property const RatePlanIDBusiness RatePlanID = "business" Link to this property const RatePlanIDEnterprise RatePlanID = "enterprise" Link to this property const RatePlanIDPartnersFree RatePlanID = "partners\_free" Link to this property const RatePlanIDPartnersPro RatePlanID = "partners\_pro" Link to this property const RatePlanIDPartnersBusiness RatePlanID = "partners\_business" Link to this property const RatePlanIDPartnersEnterprise RatePlanID = "partners\_enterprise" Link to this property
Link to this property Currency stringOptional The currency applied to the rate plan subscription. Link to this property ExternallyManaged boolOptional Whether this rate plan is managed externally from Cloudflare. Link to this property IsContract boolOptional Whether a rate plan is enterprise-based (or newly adopted term contract). Link to this property PublicName stringOptional The full name of the rate plan. Link to this property Scope stringOptional The scope that this rate plan applies to. Link to this property Sets \[]stringOptional The list of sets this rate plan applies to. Returns array of strings. Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20rate_plan%20%3E%20(schema)>)
type ResponseInfo struct{…} Code int64 minimum1000 Link to this property Message string Link to this property DocumentationURL stringOptional Link to this property
Source ResponseInfoSourceOptional Pointer stringOptional Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20response_info%20%3E%20(schema)>)
type Result interface{…} One of the following:
ResultObject
Errors \[]ResponseInfoOptional Code int64 minimum1000 Link to this property Message string Link to this property DocumentationURL stringOptional Link to this property
Source ResponseInfoSourceOptional Pointer stringOptional Link to this property
Link to this property
Link to this property
Messages \[]ResponseInfoOptional Code int64 minimum1000 Link to this property Message string Link to this property DocumentationURL stringOptional Link to this property
Source ResponseInfoSourceOptional Pointer stringOptional Link to this property
Link to this property
Link to this property
Result \[]AuditLogOptional ID stringOptional A string that uniquely identifies the audit log. Link to this property
Action AuditLogActionOptional Result boolOptional A boolean that indicates if the action attempted was successful. Link to this property Type stringOptional A short string that describes the action that was performed. Link to this property
Link to this property
Actor AuditLogActorOptional ID stringOptional The ID of the actor that performed the action. If a user performed the action, this will be their User ID. Link to this property Email stringOptional The email of the user that performed the action. formatemail Link to this property IP stringOptional The IP address of the request that performed the action. Link to this property
Type AuditLogActorTypeOptional The type of actor, whether a User, Cloudflare Admin, or an Automated System. One of the following: const AuditLogActorTypeUser AuditLogActorType = "user" Link to this property const AuditLogActorTypeAdmin AuditLogActorType = "admin" Link to this property const AuditLogActorTypeCloudflare AuditLogActorType = "Cloudflare" Link to this property
Link to this property
Link to this property Interface stringOptional The source of the event. Link to this property Metadata unknownOptional An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. Link to this property NewValue stringOptional The new value of the resource that was modified. Link to this property OldValue stringOptional The value of the resource before it was modified. Link to this property
Owner AuditLogOwnerOptional ID stringOptional Identifier maxLength32 Link to this property
Link to this property
Resource AuditLogResourceOptional ID stringOptional An identifier for the resource that was affected by the action. Link to this property Type stringOptional A short string that describes the resource that was affected by the action. Link to this property
Link to this property When TimeOptional A UTC RFC3339 timestamp that specifies when the action being logged occured. formatdate-time Link to this property
Link to this property Success boolOptional Link to this property
Link to this property
ResultAaaAPIResponseCommon
Errors \[]ResponseInfo Code int64 minimum1000 Link to this property Message string Link to this property DocumentationURL stringOptional Link to this property
Source ResponseInfoSourceOptional Pointer stringOptional Link to this property
Link to this property
Link to this property
Messages \[]ResponseInfo Code int64 minimum1000 Link to this property Message string Link to this property DocumentationURL stringOptional Link to this property
Source ResponseInfoSourceOptional Pointer stringOptional Link to this property
Link to this property
Link to this property Success ResultAaaAPIResponseCommonSuccess Whether the API call was successful Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20result%20%3E%20(schema)>)
type Role struct{…} ID string Role identifier tag. maxLength32 Link to this property Description string Description of role’s permissions. Link to this property Name string Role name. maxLength120 Link to this property
Permissions RolePermissions Analytics PermissionGrantOptional Link to this property Billing PermissionGrantOptional Link to this property CachePurge PermissionGrantOptional Link to this property DNS PermissionGrantOptional Link to this property DNSRecords PermissionGrantOptional Link to this property LB PermissionGrantOptional Link to this property Logs PermissionGrantOptional Link to this property Organization PermissionGrantOptional Link to this property SSL PermissionGrantOptional Link to this property WAF PermissionGrantOptional Link to this property ZoneSettings PermissionGrantOptional Link to this property Zones PermissionGrantOptional Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20role%20%3E%20(schema)>)
type SortDirection string Direction to order DNS records in. One of the following: const SortDirectionAsc SortDirection = "asc" Link to this property const SortDirectionDesc SortDirection = "desc" Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20sort_direction%20%3E%20(schema)>)
type Subscription struct{…} ID stringOptional Subscription identifier tag. maxLength32 Link to this property Currency stringOptional The monetary unit in which pricing information is displayed. Link to this property CurrentPeriodEnd TimeOptional The end of the current period and also when the next billing is due. formatdate-time Link to this property CurrentPeriodStart TimeOptional When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time Link to this property
Frequency SubscriptionFrequencyOptional How often the subscription is renewed automatically. One of the following: const SubscriptionFrequencyWeekly SubscriptionFrequency = "weekly" Link to this property const SubscriptionFrequencyMonthly SubscriptionFrequency = "monthly" Link to this property const SubscriptionFrequencyQuarterly SubscriptionFrequency = "quarterly" Link to this property const SubscriptionFrequencyYearly SubscriptionFrequency = "yearly" Link to this property
Link to this property Price float64Optional The price of the subscription that will be billed, in US dollars. Link to this property RatePlan RatePlanOptional The rate plan applied to the subscription. Link to this property
State SubscriptionStateOptional The state that the subscription is in. One of the following: const SubscriptionStateTrial SubscriptionState = "Trial" Link to this property const SubscriptionStateProvisioned SubscriptionState = "Provisioned" Link to this property const SubscriptionStatePaid SubscriptionState = "Paid" Link to this property const SubscriptionStateAwaitingPayment SubscriptionState = "AwaitingPayment" Link to this property const SubscriptionStateCancelled SubscriptionState = "Cancelled" Link to this property const SubscriptionStateFailed SubscriptionState = "Failed" Link to this property const SubscriptionStateExpired SubscriptionState = "Expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>)
type SubscriptionComponent struct{…} A component value for a subscription. Default float64Optional The default amount assigned. Link to this property DisplayName stringOptional A human-readable version of the component name. Link to this property
Kind SubscriptionComponentKindOptional The type of component value. “enum” for discrete values (including boolean on/off toggles where 0=off and 1=on), “sum” for countable quantities, “usage” for metered billing components. One of the following: const SubscriptionComponentKindEnum SubscriptionComponentKind = "enum" Link to this property const SubscriptionComponentKindSum SubscriptionComponentKind = "sum" Link to this property const SubscriptionComponentKindUsage SubscriptionComponentKind = "usage" Link to this property
Link to this property Name stringOptional The name of the component value. Link to this property Price float64Optional The unit price for the component value. Link to this property Value float64Optional The amount of the component value assigned. Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20subscription_component%20%3E%20(schema)>)
type SubscriptionZone struct{…} A simple zone object. May have null properties if not a zone subscription. ID stringOptional Identifier maxLength32 Link to this property Name stringOptional The domain name maxLength253 Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20subscription_zone%20%3E%20(schema)>)
type Token struct{…} ID stringOptional Token identifier tag. maxLength32 Link to this property
Condition TokenConditionOptional
RequestIP TokenConditionRequestIPOptional Client IP restrictions. In \[]TokenConditionCIDRListOptional List of IPv4/IPv6 CIDR addresses. Link to this property NotIn \[]TokenConditionCIDRListOptional List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property CreatorEmailAtCreation stringOptional The email address of the user who created the token at the time of creation. Only present for Account Owned API Tokens when a creator email was available. maxLength90 Link to this property ExpiresOn TimeOptional The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property IssuedOn TimeOptional The time on which the token was created. formatdate-time Link to this property LastUsedOn TimeOptional Last time the token was used. formatdate-time Link to this property ModifiedOn TimeOptional Last time the token was modified. formatdate-time Link to this property Name stringOptional Token name. maxLength120 Link to this property NotBefore TimeOptional The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
Policies \[]TokenPolicyOptional List of access policies assigned to the token. ID string Policy identifier. Link to this property
Effect TokenPolicyEffect Allow or deny operations against the resources. One of the following: const TokenPolicyEffectAllow TokenPolicyEffect = "allow" Link to this property const TokenPolicyEffectDeny TokenPolicyEffect = "deny" Link to this property
Link to this property
PermissionGroups \[]TokenPolicyPermissionGroup A set of permission groups that are specified to the policy. ID string Identifier of the permission group. Link to this property
Meta TokenPolicyPermissionGroupsMetaOptional Attributes associated to the permission group. Category stringOptional A category used to group permission groups. Link to this property Deprecated stringOptional Indicates whether the permission group is deprecated. Link to this property Description stringOptional Additional information about the permission group. Link to this property Editable stringOptional Indicates whether the permission group can be edited. Link to this property EolAt TimeOptional The planned end-of-life date and time, when provided. formatdate-time Link to this property Label stringOptional A label identifying the permission group. Link to this property Scopes stringOptional The scope associated with the permission group. Link to this property Visibility stringOptional Indicates the permission group’s availability or visibility. Link to this property
Link to this property Name stringOptional Name of the permission group. Link to this property
Link to this property
Resources TokenPolicyResourcesUnion A list of resource names that the policy applies to. One of the following: type TokenPolicyResourcesIAMResourcesTypeObjectString map\[string, string] Map of simple string resource permissions Link to this property type TokenPolicyResourcesIAMResourcesTypeObjectNested map\[string, map\[string, string]] Map of nested resource permissions Link to this property
Link to this property
Link to this property ProvisionerID stringOptional The identifier of the service that provisioned the token. For an OAuth-provisioned token, this is the OAuth client identifier. Present when provisioner_type is present and null when the identifier is unavailable. Link to this property ProvisionerType stringOptional The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
Status TokenStatusOptional Status of the token. One of the following: const TokenStatusActive TokenStatus = "active" Link to this property const TokenStatusDisabled TokenStatus = "disabled" Link to this property const TokenStatusExpired TokenStatus = "expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token%20%3E%20(schema)>) type TokenConditionCIDRList string IPv4/IPv6 CIDR. [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_condition_cidr_list%20%3E%20(schema)>)
type TokenPolicy struct{…} ID string Policy identifier. Link to this property
Effect TokenPolicyEffect Allow or deny operations against the resources. One of the following: const TokenPolicyEffectAllow TokenPolicyEffect = "allow" Link to this property const TokenPolicyEffectDeny TokenPolicyEffect = "deny" Link to this property
Link to this property
PermissionGroups \[]TokenPolicyPermissionGroup A set of permission groups that are specified to the policy. ID string Identifier of the permission group. Link to this property
Meta TokenPolicyPermissionGroupsMetaOptional Attributes associated to the permission group. Category stringOptional A category used to group permission groups. Link to this property Deprecated stringOptional Indicates whether the permission group is deprecated. Link to this property Description stringOptional Additional information about the permission group. Link to this property Editable stringOptional Indicates whether the permission group can be edited. Link to this property EolAt TimeOptional The planned end-of-life date and time, when provided. formatdate-time Link to this property Label stringOptional A label identifying the permission group. Link to this property Scopes stringOptional The scope associated with the permission group. Link to this property Visibility stringOptional Indicates the permission group’s availability or visibility. Link to this property
Link to this property Name stringOptional Name of the permission group. Link to this property
Link to this property
Resources TokenPolicyResourcesUnion A list of resource names that the policy applies to. One of the following: type TokenPolicyResourcesIAMResourcesTypeObjectString map\[string, string] Map of simple string resource permissions Link to this property type TokenPolicyResourcesIAMResourcesTypeObjectNested map\[string, map\[string, string]] Map of nested resource permissions Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_policy%20%3E%20(schema)>) type TokenValue string The token value. [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_value%20%3E%20(schema)>)