Cloud Organization API, gRPC: OsLoginService

Call	Description
GetSettings	OsLogin settings
UpdateSettings
GetProfile	OsLogin Profiles
ListProfiles
CreateProfile
UpdateProfile
SetDefaultProfile	Sets a profile as a default for the subject assigned to this profile
DeleteProfile

Calls OsLoginServiceCalls OsLoginService

GetSettingsGetSettings

OsLogin settings

rpc GetSettings (GetOsLoginSettingsRequest) returns (OsLoginSettings)

GetOsLoginSettingsRequestGetOsLoginSettingsRequest

Field	Description
organization_id	string Required. The maximum string length in characters is 50.

OsLoginSettingsOsLoginSettings

Field	Description
user_ssh_key_settings	UserSshKeySettings
ssh_certificate_settings	SshCertificateSettings

UserSshKeySettingsUserSshKeySettings

Field	Description
enabled	bool
allow_manage_own_keys	bool

SshCertificateSettingsSshCertificateSettings

Field	Description
enabled	bool

UpdateSettingsUpdateSettings

rpc UpdateSettings (UpdateOsLoginSettingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateOsLoginSettingsMetadata

    Operation.response:OsLoginSettings

UpdateOsLoginSettingsRequestUpdateOsLoginSettingsRequest

Field	Description
organization_id	string Required. The maximum string length in characters is 50.
user_ssh_key_settings	UserSshKeySettings
ssh_certificate_settings	SshCertificateSettings
update_mask	google.protobuf.FieldMask

UserSshKeySettingsUserSshKeySettings

Field	Description
enabled	bool
allow_manage_own_keys	bool

SshCertificateSettingsSshCertificateSettings

Field	Description
enabled	bool

UserSshKeySettingsUserSshKeySettings

Field	Description
enabled	bool
allow_manage_own_keys	bool

SshCertificateSettingsSshCertificateSettings

Field	Description
enabled	bool

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateOsLoginSettingsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<OsLoginSettings> if operation finished successfully.

UpdateOsLoginSettingsMetadataUpdateOsLoginSettingsMetadata

Field	Description
organization_id	string

OsLoginSettingsOsLoginSettings

Field	Description
user_ssh_key_settings	UserSshKeySettings
ssh_certificate_settings	SshCertificateSettings

GetProfileGetProfile

OsLogin Profiles

rpc GetProfile (GetOsLoginProfileRequest) returns (OsLoginProfile)

GetOsLoginProfileRequestGetOsLoginProfileRequest

Field	Description
os_login_profile_id	string Required. The maximum string length in characters is 50.

OsLoginProfileOsLoginProfile

Field	Description
id	string
organization_id	string
subject_id	string
login	string
uid	int64
is_default	bool
home_directory	string
shell	string

ListProfilesListProfiles

rpc ListProfiles (ListOsLoginProfilesRequest) returns (ListOsLoginProfilesResponse)

ListOsLoginProfilesRequestListOsLoginProfilesRequest

Field	Description
organization_id	string Required. The maximum string length in characters is 50.
page_size	int64 Acceptable values are 0 to 1000, inclusive.
page_token	string The maximum string length in characters is 2000.
filter	string A filter expression that filters profiles listed in the response. The expression must specify: The field name. Currently you can use filtering by subject_id, uid or login. An = operator. The value in double quotes ("). E.g. login="example-login" The maximum string length in characters is 1000.

ListOsLoginProfilesResponseListOsLoginProfilesResponse

Field	Description
profiles[]	OsLoginProfile
next_page_token	string

OsLoginProfileOsLoginProfile

Field	Description
id	string
organization_id	string
subject_id	string
login	string
uid	int64
is_default	bool
home_directory	string
shell	string

CreateProfileCreateProfile

rpc CreateProfile (CreateOsLoginProfileRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateOsLoginProfileMetadata

    Operation.response:OsLoginProfile

CreateOsLoginProfileRequestCreateOsLoginProfileRequest

Field	Description
organization_id	string Required. The maximum string length in characters is 50.
subject_id	string The maximum string length in characters is 50.
login	string Required. The maximum string length in characters is 32. Value must match the regular expression ^[^.]*?[^~.]$.
uid	int64 Acceptable values are 1000 to 9223372036854775807, inclusive.
home_directory	string The maximum string length in characters is 255.
shell	string The maximum string length in characters is 255.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateOsLoginProfileMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<OsLoginProfile> if operation finished successfully.

CreateOsLoginProfileMetadataCreateOsLoginProfileMetadata

Field	Description
os_login_profile_id	string
organization_id	string
subject_id	string

OsLoginProfileOsLoginProfile

Field	Description
id	string
organization_id	string
subject_id	string
login	string
uid	int64
is_default	bool
home_directory	string
shell	string

UpdateProfileUpdateProfile

rpc UpdateProfile (UpdateOsLoginProfileRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateOsLoginProfileMetadata

    Operation.response:OsLoginProfile

UpdateOsLoginProfileRequestUpdateOsLoginProfileRequest

Field	Description
os_login_profile_id	string Required. The maximum string length in characters is 50.
login	string Required. The maximum string length in characters is 32. Value must match the regular expression ^[^.]*?[^~.]$.
uid	int64 Acceptable values are 1000 to 9223372036854775807, inclusive.
home_directory	string The maximum string length in characters is 255.
shell	string The maximum string length in characters is 255.
update_mask	google.protobuf.FieldMask

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateOsLoginProfileMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<OsLoginProfile> if operation finished successfully.

UpdateOsLoginProfileMetadataUpdateOsLoginProfileMetadata

Field	Description
os_login_profile_id	string

OsLoginProfileOsLoginProfile

Field	Description
id	string
organization_id	string
subject_id	string
login	string
uid	int64
is_default	bool
home_directory	string
shell	string

SetDefaultProfileSetDefaultProfile

Sets a profile as a default for the subject assigned to this profile

rpc SetDefaultProfile (SetDefaultOsLoginProfileRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetDefaultOsLoginProfileMetadata

    Operation.response:OsLoginProfile

SetDefaultOsLoginProfileRequestSetDefaultOsLoginProfileRequest

Field	Description
os_login_profile_id	string Required. The maximum string length in characters is 50.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<SetDefaultOsLoginProfileMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<OsLoginProfile> if operation finished successfully.

SetDefaultOsLoginProfileMetadataSetDefaultOsLoginProfileMetadata

Field	Description
previous_default_profile_id	string
current_default_profile_id	string

OsLoginProfileOsLoginProfile

Field	Description
id	string
organization_id	string
subject_id	string
login	string
uid	int64
is_default	bool
home_directory	string
shell	string

DeleteProfileDeleteProfile

rpc DeleteProfile (DeleteOsLoginProfileRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteOsLoginProfileMetadata

    Operation.response:google.protobuf.Empty

DeleteOsLoginProfileRequestDeleteOsLoginProfileRequest

Field	Description
id	string Required. The maximum string length in characters is 50.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteOsLoginProfileMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteOsLoginProfileMetadataDeleteOsLoginProfileMetadata

Field	Description
os_login_profile_id	string