github.com/cloudwan/edgelq-sdk@v1.15.4/iam/proto/v1/user_custom.proto (about)

     1  syntax = "proto3";
     2  
     3  package ntt.iam.v1;
     4  
     5  import "edgelq-sdk/iam/proto/v1/user.proto";
     6  import "edgelq-sdk/iam/proto/v1/user_change.proto";
     7  import "google/protobuf/field_mask.proto";
     8  import "goten-sdk/types/view.proto";
     9  
    10  option go_package = "github.com/cloudwan/edgelq-sdk/iam/client/v1/user;user_client";
    11  option java_multiple_files = false;
    12  option java_outer_classname = "UserCustomProto";
    13  option java_package = "com.ntt.iam.pb.v1";
    14  
    15  // Request message for method [GetUserByEmail][ntt.iam.v1.GetUserByEmail]
    16  message GetUserByEmailRequest {
    17    //  reference of ntt.iam.v1.User
    18    string email = 1;
    19  
    20    // A list of extra fields to be obtained for each response item on top of
    21    // fields defined by request field view
    22    google.protobuf.FieldMask field_mask = 3;
    23  
    24    // View defines list of standard response fields present in response items.
    25    // Additional fields can be amended by request field field_mask
    26    goten.types.View view = 4;
    27  
    28    // If true, server will skip checking if query result is present in it's cache
    29    bool skip_cache = 5;
    30  }
    31  
    32  // Request message for method
    33  // [BatchGetUsersByEmail][ntt.iam.v1.BatchGetUsersByEmail]
    34  message BatchGetUsersByEmailRequest {
    35    // Emails of users
    36    repeated string emails = 2;
    37  
    38    // A list of extra fields to be obtained for each response item on top of
    39    // fields defined by request field view
    40    google.protobuf.FieldMask field_mask = 3;
    41  
    42    // View defines list of standard response fields present in response items.
    43    // Additional fields can be amended by request field field_mask
    44    goten.types.View view = 4;
    45  
    46    // If true, server will skip checking if query result is present in it's cache
    47    bool skip_cache = 5;
    48  }
    49  
    50  // Response message for method
    51  // [BatchGetUsersByEmail][ntt.iam.v1.BatchGetUsersByEmail]
    52  message BatchGetUsersByEmailResponse {
    53    // found Users
    54    repeated User users = 1;
    55  
    56    // list of not found user emails
    57    repeated string missing = 2;
    58  }
    59  
    60  // Request message for method [GetMySettings][ntt.iam.v1.GetMySettings]
    61  message GetMySettingsRequest {
    62    // list of keys to retrieve
    63    repeated string keys = 1;
    64  }
    65  
    66  // Response message for method [GetMySettings][ntt.iam.v1.GetMySettings]
    67  message GetMySettingsResponse {
    68    // resulting settings
    69    map<string, string> settings = 1;
    70  }
    71  
    72  // Request message for method [SetMySettings][ntt.iam.v1.SetMySettings]
    73  message SetMySettingsRequest {
    74    // Settings to update. Leave empty value to unset key
    75    map<string, string> settings = 1;
    76  }
    77  
    78  // Request message for method
    79  // [RefreshUserFromIdToken][ntt.iam.v1.RefreshUserFromIdToken]
    80  message RefreshUserFromIdTokenRequest {
    81    // JWT-encoded ID token
    82    string id_token = 1;
    83  }
    84  
    85  // Response message for method
    86  // [RefreshUserFromIdToken][ntt.iam.v1.RefreshUserFromIdToken]
    87  message RefreshUserFromIdTokenResponse {}
    88  
    89  // Request message for method
    90  // [ResendVerificationEmail][ntt.iam.v1.ResendVerificationEmail]
    91  message ResendVerificationEmailRequest {
    92    // Optional Auth client ID. May be defined per application to customize email
    93    // template.
    94    string client_id = 1;
    95  }
    96  
    97  // Request message for method [IsUserVerified][ntt.iam.v1.IsUserVerified]
    98  message IsUserVerifiedRequest {}
    99  
   100  // Request message for method
   101  // [ResetMFAIfRecoveryKeyUsed][ntt.iam.v1.ResetMFAIfRecoveryKeyUsed]
   102  message ResetMFAIfRecoveryKeyUsedRequest {}
   103  
   104  // Request message for method
   105  // [SetUsersNameInAuth0][ntt.iam.v1.SetUsersNameInAuth0]
   106  message SetUsersNameInAuth0Request {}
   107  
   108  // Request message for method
   109  // [DeleteUsersByCriteria][ntt.iam.v1.DeleteUsersByCriteria]
   110  message DeleteUsersByCriteriaRequest {
   111    oneof to_delete {
   112      // Delete by email criteria
   113      UserEmails by_email = 1;
   114  
   115      // Delete by name criteria
   116      UserNames by_name = 2;
   117    }
   118  
   119    // Auth info provider type. Optional. If provided, it must match
   120    // deleted user instances - field auth_info.provider must exactly
   121    // match specified value.
   122    string auth_info_provider = 3;
   123  
   124    // Auth info ID prefix. Optional. If provided, it must match
   125    // deleted user instances - field auth_info.id must begin
   126    // with specified prefix.
   127    string auth_info_id_prefix = 4;
   128  
   129    message UserEmails { repeated string values = 1; }
   130  
   131    message UserNames { repeated string values = 1; }
   132  }
   133  
   134  // Response message for method
   135  // [DeleteUserByCriteria][ntt.iam.v1.DeleteUserByCriteria]
   136  message DeleteUsersByCriteriaResponse {
   137    // List of deleted user resources
   138    repeated string deleted_users = 1;
   139  }