Identity Hub API, REST: Group.CreateExternal

Field

Description

organizationId

string

Required field. ID of the organization to create a group in.
To get the organization ID, use a yandex.cloud.organizationmanager.v1.OrganizationService.List request.

name

string

Required field. Name of the group.
The name must be unique within the organization.

description

string

Description of the group.

subjectContainerId

string

Required field. Id of the subject container that external group belongs to.
Combination of subject_container_id and external_id must be unique.
To get subject container, use a yandex.cloud.organizationmanager.v1.saml.FederationService.List request
or yandex.cloud.organizationmanager.v1.idp.UserpoolService.List request.

externalId

string

Required field. Id of the group from external system.
Combination of subject_container_id and external_id must be unique

makeEditor

boolean

If true, then creator of group will be assigned to role that allows modification of group as external group.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

CreateExternalGroupMetadata

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.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

Group

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

Field

Description

groupId

string

ID of the group that is being created.

organizationId

string

ID of the organization that the group belongs to.

groupName

string

Name of the group.

subjectContainerId

string

Id of the subject container that created external group belongs to.

externalId

string

Id of the created group from external system.

makeEditor

boolean

If true, then creator of group was assigned to role that allows modification of group as external group.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

ID of the group.

organizationId

string

ID of the organization that the group belongs to.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the group.

description

string

Description of the group.

subjectContainerId

string

Id of the subject container that external group belongs to. It is set if group is external.

externalId

string

Id of the group from external system. It is set if group is external.