Skip to main content

types

ApiKey​

An ApiKey resource. For more information, see Api-Key.

id : string​

ID of the API Key.

serviceAccountId : string​

ID of the service account that the API key belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

description : string​

Description of the API key. 0-256 characters long.

lastUsedAt : google.protobuf.Timestamp​

Timestamp for the last authentication using this API key.

scope : string​

Scope of the API key. 0-256 characters long.

expiresAt : google.protobuf.Timestamp​

API key expiration timestamp.

Key​

A Key resource. For more information, see Authorized keys.

Algorithm​

  • ALGORITHM_UNSPECIFIED

  • RSA_2048

    RSA with a 2048-bit key size. Default value.

  • RSA_4096

    RSA with a 4096-bit key size.

id : string​

ID of the Key resource.

One of subject​

  • userAccountId : string​

    ID of the user account that the Key resource belongs to.

  • serviceAccountId : string​

    ID of the service account that the Key resource belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

description : string​

Description of the Key resource. 0-256 characters long.

keyAlgorithm : Algorithm​

An algorithm used to generate a key pair of the Key resource.

publicKey : string​

A public key of the Key resource.

lastUsedAt : google.protobuf.Timestamp​

Timestamp for the last use of this key.

RefreshToken​

ProtectionLevel​

Protection level of the refresh token.

  • PROTECTION_LEVEL_UNSPECIFIED

    Protection level of the refresh token.

  • NO_PROTECTION

    Refresh token without DPOP

  • INSECURE_KEY_DPOP

    Refresh token with dpop. The dpop key is not a YubiKey PIV key with required pin/touch policy and attestation.

  • SECURE_KEY_DPOP

    Refresh token with dpop. The dpop key is a YubiKey PIV key with required pin/touch policy and attestation.

id : string​

Refresh Token id.

clientInstanceInfo : string​

Information about the app for which the Refresh Token was issued.

clientId : string​

The OAuth client identifier for which the Refresh Token was issued.

subjectId : string​

The subject identifier for whom the Refresh Token was issued.

createdAt : google.protobuf.Timestamp​

Refresh token creation time.

expiresAt : google.protobuf.Timestamp​

Refresh token expiration time.

lastUsedAt : google.protobuf.Timestamp​

Timestamp for the last authentication using this Refresh Token.

protectionLevel : RefreshToken.ProtectionLevel​

Protection level of the refresh token.

It shows whether DPOP was used to protect the Refresh Token and and the level of security of the storage used for the DPOP key.

Resource​

A Resource. For more information, see Resource.

id : string​

ID of the resource.

type : string​

The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc.

Role​

A Role resource. For more information, see Roles.

id : string​

ID of the role.

description : string​

Description of the role. 0-256 characters long.

SamlUserAccount​

A SAML federated user. For more information, see federations.

Attribute​

value : string​
federationId : string​

ID of the federation that the federation belongs to.

nameId : string​

Name Id of the SAML federated user. The name is unique within the federation. 1-256 characters long.

attributes : Attribute​

Additional attributes of the SAML federated user.

Service​

A Service.

Status​

  • STATUS_UNSPECIFIED

  • ENABLED

    The service is enabled.

  • PAUSED

    The service is paused.

  • DISABLED

    The service is disabled.

  • ENABLING

    The service is being enabled.

  • RESUMING

    The service is being resumed.

  • PAUSING

    The service is being paused.

  • DISABLING

    The service is being disabled.

  • ERROR

    The service is in error state.

  • DEFAULT

    The service could be auto enabled.

serviceId : string​

ID of the service.

resource : Resource​

Resource that the service belongs to.

updatedAt : google.protobuf.Timestamp​

Time of the last status update of the service.

status : Status​

Current status of the service.

ServiceAccount​

A ServiceAccount resource. For more information, see Service accounts.

id : string​

ID of the service account.

folderId : string​

ID of the folder that the service account belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the service account. The name is unique within the cloud. 3-63 characters long.

description : string​

Description of the service account. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

lastAuthenticatedAt : google.protobuf.Timestamp​

Timestamp for the last authentication of this service account.

ServiceAgent​

serviceAccountId : string​

ID of the agent service account.

serviceId : string​

ID of the service.

microserviceId : string​

ID of the microservice.

UserAccount​

Currently represents only Yandex account.

id : string​

ID of the user account.

One of userAccount​

  • yandexPassportUserAccount : YandexPassportUserAccount​

    A YandexPassportUserAccount resource.

  • samlUserAccount : SamlUserAccount​

    A SAML federated user.

YandexPassportUserAccount​

A YandexPassportUserAccount resource. For more information, see Yandex account.

login : string​

Login of the Yandex user account.

defaultEmail : string​

Default email of the Yandex user account.