@nebius/js-sdk 0.2.6 → 0.2.8

package/dist/cjs/api/nebius/iam/v1/index.d.ts

@@ -1019,6 +1019,10 @@ export interface GetFederatedCredentialsRequest {
     $type: "nebius.iam.v1.GetFederatedCredentialsRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Target federated credentials ID.
+     *
+     */
     id: string;
 }
 export declare const GetFederatedCredentialsRequest: MessageFns<GetFederatedCredentialsRequest, "nebius.iam.v1.GetFederatedCredentialsRequest">;
@@ -1027,12 +1031,12 @@ export interface GetByNameFederatedCredentialsRequest {
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
     /**
-     *  Container (project), which contains desired credentials.
+     *  Parent container ID for the federated credentials.
      *
      */
     parentId: string;
     /**
-     *  Federated credentials name.
+     *  Target federated credentials name.
      *
      */
     name: string;
@@ -1042,7 +1046,15 @@ export interface CreateFederatedCredentialsRequest {
     $type: "nebius.iam.v1.CreateFederatedCredentialsRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federated credentials resource metadata.
+     *
+     */
     metadata?: ResourceMetadata | undefined;
+    /**
+     *  Federated credentials resource specification.
+     *
+     */
     spec?: FederatedCredentialsSpec | undefined;
 }
 export declare const CreateFederatedCredentialsRequest: MessageFns<CreateFederatedCredentialsRequest, "nebius.iam.v1.CreateFederatedCredentialsRequest">;
@@ -1050,7 +1062,15 @@ export interface UpdateFederatedCredentialsRequest {
     $type: "nebius.iam.v1.UpdateFederatedCredentialsRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federated credentials resource metadata.
+     *
+     */
     metadata?: ResourceMetadata | undefined;
+    /**
+     *  Federated credentials resource specification.
+     *
+     */
     spec?: FederatedCredentialsSpec | undefined;
 }
 export declare const UpdateFederatedCredentialsRequest: MessageFns<UpdateFederatedCredentialsRequest, "nebius.iam.v1.UpdateFederatedCredentialsRequest">;
@@ -1059,12 +1079,12 @@ export interface ListFederatedCredentialsRequest {
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
     /**
-     *  Represents the parent NID
+     *  Parent container ID for the federated credentials.
      *
      */
     parentId: string;
     /**
-     *  Specifies the maximum number of items to return in the response. Default is 10
+     *  Maximum number of items to return in the response. Default value: 10.
      *
      */
     pageSize: Long;
@@ -1074,7 +1094,7 @@ export interface ListFederatedCredentialsRequest {
      */
     pageToken: string;
     /**
-     *  A filter to narrow down the results based on specific criteria.
+     *  Filter expression for narrowing down the results.
      *
      */
     filter: string;
@@ -1085,12 +1105,12 @@ export interface ListFederatedCredentialsResponse {
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
     /**
-     *  List of user accounts returned in the response. The field should be named as `items` for consistency.
+     *  List of federated credentials returned in the response.
      *
      */
     items: FederatedCredentials[];
     /**
-     *  Token for pagination, indicating the next set of results can be retrieved using this token.
+     *  Token for pagination, allowing the retrieval of the next set of results.
      *
      */
     nextPageToken: string;
@@ -1100,6 +1120,10 @@ export interface DeleteFederatedCredentialsRequest {
     $type: "nebius.iam.v1.DeleteFederatedCredentialsRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Target federated credentials ID.
+     *
+     */
     id: string;
 }
 export declare const DeleteFederatedCredentialsRequest: MessageFns<DeleteFederatedCredentialsRequest, "nebius.iam.v1.DeleteFederatedCredentialsRequest">;
@@ -1189,21 +1213,45 @@ export declare const FederatedCredentialsServiceBaseClient: {
 };
 export interface FederatedCredentialsService {
     $type: "nebius.iam.v1.FederatedCredentialsService";
+    /**
+     *  Retrieves information about federated credentials by ID.
+     *
+     */
     get(request: GetFederatedCredentialsRequest): SDKRequestClass<GetFederatedCredentialsRequest, FederatedCredentials>;
     get(request: GetFederatedCredentialsRequest, metadata: Metadata): SDKRequestClass<GetFederatedCredentialsRequest, FederatedCredentials>;
     get(request: GetFederatedCredentialsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<GetFederatedCredentialsRequest, FederatedCredentials>;
+    /**
+     *  Retrieves information about federated credentials by name and parent container.
+     *
+     */
     getByName(request: GetByNameFederatedCredentialsRequest): SDKRequestClass<GetByNameFederatedCredentialsRequest, FederatedCredentials>;
     getByName(request: GetByNameFederatedCredentialsRequest, metadata: Metadata): SDKRequestClass<GetByNameFederatedCredentialsRequest, FederatedCredentials>;
     getByName(request: GetByNameFederatedCredentialsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<GetByNameFederatedCredentialsRequest, FederatedCredentials>;
+    /**
+     *  Lists federated credentials by parent container.
+     *
+     */
     list(request: ListFederatedCredentialsRequest): SDKRequestClass<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>;
     list(request: ListFederatedCredentialsRequest, metadata: Metadata): SDKRequestClass<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>;
     list(request: ListFederatedCredentialsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>;
+    /**
+     *  Creates federated credentials.
+     *
+     */
     create(request: CreateFederatedCredentialsRequest): SDKRequestClass<CreateFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
     create(request: CreateFederatedCredentialsRequest, metadata: Metadata): SDKRequestClass<CreateFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
     create(request: CreateFederatedCredentialsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<CreateFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
+    /**
+     *  Updates federated credentials.
+     *
+     */
     update(request: UpdateFederatedCredentialsRequest): SDKRequestClass<UpdateFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
     update(request: UpdateFederatedCredentialsRequest, metadata: Metadata): SDKRequestClass<UpdateFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
     update(request: UpdateFederatedCredentialsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<UpdateFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
+    /**
+     *  Deletes federated credentials.
+     *
+     */
     delete(request: DeleteFederatedCredentialsRequest): SDKRequestClass<DeleteFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
     delete(request: DeleteFederatedCredentialsRequest, metadata: Metadata): SDKRequestClass<DeleteFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
     delete(request: DeleteFederatedCredentialsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<DeleteFederatedCredentialsRequest, OperationWrapper<GetOperationRequest>>;
@@ -1239,8 +1287,20 @@ export interface FederatedCredentials {
     $type: "nebius.iam.v1.FederatedCredentials";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federated credentials resource metadata.
+     *
+     */
     metadata?: ResourceMetadata | undefined;
+    /**
+     *  Federated credentials resource specification.
+     *
+     */
     spec?: FederatedCredentialsSpec | undefined;
+    /**
+     *  Federated credentials resource status.
+     *
+     */
     status?: FederatedCredentialsStatus | undefined;
 }
 export declare const FederatedCredentials: MessageFns<FederatedCredentials, "nebius.iam.v1.FederatedCredentials">;
@@ -1249,17 +1309,18 @@ export interface FederatedCredentialsSpec {
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
     /**
-     *  Federated subject ID.For oidc_provider subject will be calculated based on the “sub” claim of the JWT federation token.
+     *  Federated subject ID. For oidc_provider, the subject is calculated from the
+     *  "sub" claim of the federated JWT token.
      *
      */
     federatedSubjectId: string;
     /**
-     *  IAM subject, in which federated subject will be impersonated to. E.g. for workload identities it will be IAM service account.
+     *  IAM subject (service account) that the federated subject impersonates.
      *
      */
     subjectId: string;
     /**
-     *  provider of federated credentials used for federated subject authentication
+     *  Provider settings used to authenticate a federated subject.
      *
      */
     credentialsProvider?: {
@@ -1268,27 +1329,27 @@ export interface FederatedCredentialsSpec {
     } | undefined;
 }
 export declare const FederatedCredentialsSpec: MessageFns<FederatedCredentialsSpec, "nebius.iam.v1.FederatedCredentialsSpec">;
+/**
+ *  The OIDC provider does not have to be a full OIDC provider, but it must expose
+ *  OIDC discovery metadata at the "/.well-known/openid-configuration" endpoint.
+ *  The discovery metadata must contain "jwks_uri", which points to the JSON Web
+ *  Key Set (JWKS). The JWKS contains public keys used to verify JSON
+ *  Web Tokens (JWTs) issued by the identity provider.
+ *
+ */
 export interface OidcCredentialsProvider {
     $type: "nebius.iam.v1.OidcCredentialsProvider";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
     /**
-     *  It's not required provider OIDC issuer should be real OIDC provider, but should expose OIDC configuration
-     *  with "/.well-known/openid-configuration" endpoint. Configuration should contains the "jwks_uri" endpoint
-     *  where the JSON Web Key Set (JWKS) can be found; this set contains public keys used to verify
-     *  JSON Web Tokens (JWTs) issued by an identity provider.
-     *
-     *  Limitations for external OIDC providers:
-     *  - token service limits the number of handled keys by 50. If your JWKS return more than 50,
-     *  the only first 50 will be used for signature verifying.
-     *  - response size for jwks_uri and "/.well-known/openid-configuration limited by 100KB.
+     *  OIDC-compatible JWT issuer URL.
      *
      */
     issuerUrl: string;
     /**
-     *  Literally json, which represents JWKS with public keys for JWT verification.
-     *  It worth mentioned that in a case of adding/rotating keys the jwk_set_json also should be updated here.
-     *  Besides, the "issuer" parameter should be set even if the JWKS will be resolved locally.
+     *  JSON representation of a JSON Web Key Set (JWKS) with public keys used for
+     *  JWT signature verification.
+     *  If set, the token service uses this JWKS to verify token signatures.
      *
      */
     jwkSetJson: string;
@@ -1561,7 +1622,15 @@ export interface CreateFederationRequest {
     $type: "nebius.iam.v1.CreateFederationRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federation resource metadata.
+     *
+     */
     metadata?: ResourceMetadata | undefined;
+    /**
+     *  Federation resource specification.
+     *
+     */
     spec?: FederationSpec | undefined;
 }
 export declare const CreateFederationRequest: MessageFns<CreateFederationRequest, "nebius.iam.v1.CreateFederationRequest">;
@@ -1569,6 +1638,10 @@ export interface GetFederationRequest {
     $type: "nebius.iam.v1.GetFederationRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Target federation ID.
+     *
+     */
     id: string;
 }
 export declare const GetFederationRequest: MessageFns<GetFederationRequest, "nebius.iam.v1.GetFederationRequest">;
@@ -1576,13 +1649,25 @@ export interface ListFederationsRequest {
     $type: "nebius.iam.v1.ListFederationsRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Parent container ID for the federations.
+     *
+     */
     parentId: string;
     /**
-     *  Default value: 10
+     *  Maximum number of items to return in the response. Default value: 10.
      *
      */
     pageSize: Long;
+    /**
+     *  Token for pagination, allowing the retrieval of the next set of results.
+     *
+     */
     pageToken: string;
+    /**
+     *  Filter expression for narrowing down the results.
+     *
+     */
     filter: string;
 }
 export declare const ListFederationsRequest: MessageFns<ListFederationsRequest, "nebius.iam.v1.ListFederationsRequest">;
@@ -1590,7 +1675,15 @@ export interface ListFederationsResponse {
     $type: "nebius.iam.v1.ListFederationsResponse";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  List of federations returned in the response.
+     *
+     */
     items: Federation[];
+    /**
+     *  Token for pagination, allowing the retrieval of the next set of results.
+     *
+     */
     nextPageToken: string;
 }
 export declare const ListFederationsResponse: MessageFns<ListFederationsResponse, "nebius.iam.v1.ListFederationsResponse">;
@@ -1598,7 +1691,15 @@ export interface UpdateFederationRequest {
     $type: "nebius.iam.v1.UpdateFederationRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federation resource metadata.
+     *
+     */
     metadata?: ResourceMetadata | undefined;
+    /**
+     *  Federation resource specification.
+     *
+     */
     spec?: FederationSpec | undefined;
     /** @deprecated Deprecated: 'status' is ignored for update requests.. */
     status?: FederationStatus | undefined;
@@ -1608,6 +1709,10 @@ export interface ActivateFederationRequest {
     $type: "nebius.iam.v1.ActivateFederationRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Target federation ID.
+     *
+     */
     federationId: string;
 }
 export declare const ActivateFederationRequest: MessageFns<ActivateFederationRequest, "nebius.iam.v1.ActivateFederationRequest">;
@@ -1615,6 +1720,10 @@ export interface DeactivateFederationRequest {
     $type: "nebius.iam.v1.DeactivateFederationRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Target federation ID.
+     *
+     */
     federationId: string;
 }
 export declare const DeactivateFederationRequest: MessageFns<DeactivateFederationRequest, "nebius.iam.v1.DeactivateFederationRequest">;
@@ -1622,6 +1731,10 @@ export interface DeleteFederationRequest {
     $type: "nebius.iam.v1.DeleteFederationRequest";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Target federation ID.
+     *
+     */
     id: string;
 }
 export declare const DeleteFederationRequest: MessageFns<DeleteFederationRequest, "nebius.iam.v1.DeleteFederationRequest">;
@@ -1735,18 +1848,38 @@ export declare const FederationServiceBaseClient: {
 };
 export interface FederationService {
     $type: "nebius.iam.v1.FederationService";
+    /**
+     *  Creates a federation.
+     *
+     */
     create(request: CreateFederationRequest): SDKRequestClass<CreateFederationRequest, OperationWrapper<GetOperationRequest>>;
     create(request: CreateFederationRequest, metadata: Metadata): SDKRequestClass<CreateFederationRequest, OperationWrapper<GetOperationRequest>>;
     create(request: CreateFederationRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<CreateFederationRequest, OperationWrapper<GetOperationRequest>>;
+    /**
+     *  Retrieves information about a federation by ID.
+     *
+     */
     get(request: GetFederationRequest): SDKRequestClass<GetFederationRequest, Federation>;
     get(request: GetFederationRequest, metadata: Metadata): SDKRequestClass<GetFederationRequest, Federation>;
     get(request: GetFederationRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<GetFederationRequest, Federation>;
+    /**
+     *  Retrieves information about a federation by name and parent container.
+     *
+     */
     getByName(request: GetByNameRequest): SDKRequestClass<GetByNameRequest, Federation>;
     getByName(request: GetByNameRequest, metadata: Metadata): SDKRequestClass<GetByNameRequest, Federation>;
     getByName(request: GetByNameRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<GetByNameRequest, Federation>;
+    /**
+     *  Lists federations by parent container.
+     *
+     */
     list(request: ListFederationsRequest): SDKRequestClass<ListFederationsRequest, ListFederationsResponse>;
     list(request: ListFederationsRequest, metadata: Metadata): SDKRequestClass<ListFederationsRequest, ListFederationsResponse>;
     list(request: ListFederationsRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<ListFederationsRequest, ListFederationsResponse>;
+    /**
+     *  Updates a federation.
+     *
+     */
     update(request: UpdateFederationRequest): SDKRequestClass<UpdateFederationRequest, OperationWrapper<GetOperationRequest>>;
     update(request: UpdateFederationRequest, metadata: Metadata): SDKRequestClass<UpdateFederationRequest, OperationWrapper<GetOperationRequest>>;
     update(request: UpdateFederationRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<UpdateFederationRequest, OperationWrapper<GetOperationRequest>>;
@@ -1760,12 +1893,16 @@ export interface FederationService {
     activate(request: ActivateFederationRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<ActivateFederationRequest, OperationWrapper<GetOperationRequest>>;
     /**
      *  Deactivates an existing federation.
-     *  When a federation is inactive, all users under it will be unable to authenticate.
+     *  When a federation is inactive, all users under it cannot authenticate.
      *
      */
     deactivate(request: DeactivateFederationRequest): SDKRequestClass<DeactivateFederationRequest, OperationWrapper<GetOperationRequest>>;
     deactivate(request: DeactivateFederationRequest, metadata: Metadata): SDKRequestClass<DeactivateFederationRequest, OperationWrapper<GetOperationRequest>>;
     deactivate(request: DeactivateFederationRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<DeactivateFederationRequest, OperationWrapper<GetOperationRequest>>;
+    /**
+     *  Deletes a federation. An active federation cannot be deleted and must be deactivated first.
+     *
+     */
     delete(request: DeleteFederationRequest): SDKRequestClass<DeleteFederationRequest, OperationWrapper<GetOperationRequest>>;
     delete(request: DeleteFederationRequest, metadata: Metadata): SDKRequestClass<DeleteFederationRequest, OperationWrapper<GetOperationRequest>>;
     delete(request: DeleteFederationRequest, metadata: Metadata, options: Partial<CallOptions> & RetryOptions): SDKRequestClass<DeleteFederationRequest, OperationWrapper<GetOperationRequest>>;
@@ -1815,8 +1952,20 @@ export interface Federation {
     $type: "nebius.iam.v1.Federation";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federation resource metadata.
+     *
+     */
     metadata?: ResourceMetadata | undefined;
+    /**
+     *  Federation resource specification.
+     *
+     */
     spec?: FederationSpec | undefined;
+    /**
+     *  Federation resource status.
+     *
+     */
     status?: FederationStatus | undefined;
 }
 export declare const Federation: MessageFns<Federation, "nebius.iam.v1.Federation">;
@@ -1824,8 +1973,17 @@ export interface FederationSpec {
     $type: "nebius.iam.v1.FederationSpec";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  If false, users with access to the federation cannot sign in automatically
+     *  and user accounts for them must be pre-created by a federation administrator.
+     *
+     */
     userAccountAutoCreation: boolean;
-    /** @deprecated Deprecated: 'active' field ignored. Use 'Activate/Deactivate' methods to manage federation state. A newly created federation is always active by default.. */
+    /**
+     *  Specifies if the federation in active state
+     *
+     * @deprecated Deprecated: 'active' field ignored. Use 'Activate/Deactivate' methods to manage federation state. A newly created federation is always active by default..
+     */
     active: boolean;
     settings?: {
         $case: "samlSettings";
@@ -1837,7 +1995,15 @@ export interface SamlSettings {
     $type: "nebius.iam.v1.SamlSettings";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  The unique identifier of the SAML Identity Provider. It usually matches the entityID from the IdP metadata.
+     *
+     */
     idpIssuer: string;
+    /**
+     *  Identity Provider’s Single Sign-On endpoint. This is the URL where the user is redirected to start SAML login.
+     *
+     */
     ssoUrl: string;
     /**
      *  if "true", the identity provider MUST authenticate the presenter directly rather than rely on a previous security context.
@@ -1850,8 +2016,20 @@ export interface FederationStatus {
     $type: "nebius.iam.v1.FederationStatus";
     [unknownFieldsSymbol]?: Uint8Array | undefined;
     [customJson]?: () => unknown;
+    /**
+     *  Federation state.
+     *
+     */
     state: FederationStatus_State;
+    /**
+     *  Number of users registered in the IAM federation. This value may differ from the number of users in the identity provider.
+     *
+     */
     usersCount: number;
+    /**
+     *  Number of certificates attached to the SAML federation for verifying SAML responses.
+     *
+     */
     certificatesCount: number;
 }
 export declare const FederationStatus: MessageFns<FederationStatus, "nebius.iam.v1.FederationStatus">;