github.com/cloudwan/edgelq-sdk@v1.15.4/iam/proto/api-skeleton-v1alpha2.yaml (about)

     1  name: iam.edgelq.com
     2  proto:
     3    package:
     4      name: ntt.iam
     5      currentVersion: v1alpha2
     6      nextVersion: v1
     7      goPackage: github.com/cloudwan/edgelq/iam
     8      protoImportPathPrefix: edgelq/iam/proto
     9    service:
    10      name: IAM
    11      defaultHost: iam.edgelq.com
    12      oauthScopes: https://apis.edgelq.com
    13  imports:
    14  - meta.edgelq.com
    15  
    16  resources:
    17  - name: Permission
    18  
    19  - name: Role
    20  
    21  - name: Organization
    22    actions:
    23    - name: ListMyOrganizations
    24      verb: listMy
    25      opResourceInfo:
    26        isCollection: true
    27        isPlural: true
    28        responsePaths:
    29          resourceBody: [ "organizations" ]
    30      withStoreHandle:
    31        readOnly: true
    32        transaction: NONE
    33  
    34  - name: Group
    35    parents:
    36    - Project
    37    - Organization
    38    - ""
    39  
    40  - name: GroupMember
    41    parents:
    42    - Group
    43  
    44  - name: OrganizationInvitation
    45    parents:
    46    - Organization
    47    actions:
    48    - name: AcceptOrganizationInvitation
    49      verb: accept
    50      withStoreHandle:
    51        transaction: SNAPSHOT
    52    - name: DeclineOrganizationInvitation
    53      verb: decline
    54      withStoreHandle:
    55        transaction: SNAPSHOT
    56    - name: ListMyOrganizationInvitations
    57      verb: listMy
    58      opResourceInfo:
    59        isCollection: true
    60        isPlural: true
    61        responsePaths:
    62          resourceBody: [ "organization_invitations" ]
    63      withStoreHandle:
    64        readOnly: true
    65        transaction: NONE
    66  
    67  - name: Project
    68    actions:
    69    - name: ListMyProjects
    70      verb: listMy
    71      opResourceInfo:
    72        isCollection: true
    73        isPlural: true
    74        responsePaths:
    75          resourceBody: [ "projects" ]
    76      withStoreHandle:
    77        readOnly: true
    78        transaction: NONE
    79  
    80  - name: ServiceAccount
    81    scopeAttributes:
    82    - Region
    83    parents:
    84    - Project
    85  
    86  - name: ServiceAccountKey
    87    parents:
    88    - ServiceAccount
    89  
    90  - name: ProjectInvitation
    91    parents:
    92    - Project
    93    actions:
    94    - name: AcceptProjectInvitation
    95      verb: accept
    96      withStoreHandle:
    97        transaction: SNAPSHOT
    98    - name: DeclineProjectInvitation
    99      verb: decline
   100      withStoreHandle:
   101        transaction: SNAPSHOT
   102    - name: ListMyProjectInvitations
   103      verb: listMy
   104      opResourceInfo:
   105        isCollection: true
   106        isPlural: true
   107      withStoreHandle:
   108        readOnly: true
   109        transaction: NONE
   110    - name: ResendProjectInvitation
   111      verb: resend
   112      withStoreHandle:
   113        transaction: SNAPSHOT
   114  
   115  - name: User
   116    actions:
   117    - name: GetUserByEmail
   118      verb: getByEmail
   119      opResourceInfo:
   120        skipResourceInRequest: true
   121      skipResponseMsgGen: true
   122      responseName: User
   123      withStoreHandle:
   124        readOnly: true
   125        transaction: NONE
   126    - name: BatchGetUsersByEmail
   127      verb: batchGetByEmail
   128      opResourceInfo:
   129        isPlural: true
   130        skipResourceInRequest: true
   131      withStoreHandle:
   132        readOnly: true
   133        transaction: NONE
   134  
   135    - name: GetMySettings
   136      verb: getMySettings
   137      opResourceInfo:
   138        isCollection: true
   139        isPlural: false
   140        skipResourceInRequest: true
   141      withStoreHandle:
   142        readOnly: true
   143        transaction: NONE
   144    - name: SetMySettings
   145      verb: setMySettings
   146      opResourceInfo:
   147        isCollection: true
   148        isPlural: false
   149        skipResourceInRequest: true
   150      responseName: google.protobuf.Empty
   151      skipResponseMsgGen: true
   152      withStoreHandle:
   153        transaction: SNAPSHOT
   154  
   155    - name: RefreshUserFromIdToken
   156      verb: refreshUserFromIdToken
   157      opResourceInfo:
   158        isCollection: true
   159        skipResourceInRequest: true
   160      multiRegionRouting:
   161        executeOnOwningRegion: true
   162      withStoreHandle:
   163        transaction: MANUAL
   164  
   165    - name: ResendVerificationEmail
   166      verb: resendVerificationEmail
   167      opResourceInfo:
   168        isCollection: true
   169        isPlural: false
   170      skipResponseMsgGen: true
   171      responseName: google.protobuf.Empty
   172      withStoreHandle:
   173        transaction: SNAPSHOT
   174        
   175    - name: IsUserVerified
   176      verb: isUserVerified
   177      opResourceInfo:
   178        isCollection: true
   179        isPlural: false
   180      skipResponseMsgGen: true
   181      responseName: google.protobuf.Empty
   182      withStoreHandle:
   183        transaction: MANUAL
   184  
   185    - name: ResetMFAIfRecoveryKeyUsed
   186      verb: resetMFAIfRecoveryKeyUsed
   187      opResourceInfo:
   188        isCollection: true
   189        isPlural: false
   190      skipResponseMsgGen: true
   191      responseName: google.protobuf.Empty
   192      withStoreHandle:
   193        transaction: SNAPSHOT
   194  
   195    - name: SetUsersNameInAuth0
   196      verb: setUsersNameInAuth0
   197      opResourceInfo:
   198        isCollection: true
   199        isPlural: false
   200      skipResponseMsgGen: true
   201      responseName: google.protobuf.Empty
   202      withStoreHandle:
   203        transaction: SNAPSHOT
   204  
   205  - name: RoleBinding
   206    parents:
   207    - Project
   208    - Organization
   209    - ""
   210    multiRegion:
   211      syncType: ALWAYS_IN_SCOPE
   212  
   213  - name: Condition
   214    parents:
   215    - Project
   216    - Organization
   217    - ""
   218    multiRegion:
   219      syncType: ALWAYS_IN_SCOPE
   220  
   221  - name: AttestationDomain
   222    plural: AttestationDomains
   223    parents:
   224    - Project
   225  
   226  apis:
   227  - name: Authorization
   228    actions:
   229    - name: CheckPermissions
   230      verb: check
   231      opResourceInfo:
   232        name: Permission
   233        isCollection: true
   234        isPlural: true
   235        skipResourceInRequest: true
   236      grpcTranscoding:
   237        httpBodyField: "*"
   238      withStoreHandle:
   239        readOnly: true
   240        transaction: NONE
   241      multiRegionRouting:
   242        skipCodeGenBasedRouting: true
   243    - name: CheckMyPermissions
   244      verb: checkMy
   245      opResourceInfo:
   246        name: Permission
   247        isCollection: true
   248        isPlural: true
   249        skipResourceInRequest: true
   250      grpcTranscoding:
   251        httpBodyField: "*"
   252      withStoreHandle:
   253        readOnly: true
   254        transaction: NONE
   255      multiRegionRouting:
   256        skipCodeGenBasedRouting: true
   257    - name: CheckMyRoles
   258      verb: checkMy
   259      opResourceInfo:
   260        name: Role
   261        isCollection: true
   262        isPlural: true
   263        skipResourceInRequest: true
   264      grpcTranscoding:
   265        httpBodyField: "*"
   266      withStoreHandle:
   267        readOnly: true
   268        transaction: NONE
   269      multiRegionRouting:
   270        skipCodeGenBasedRouting: true
   271      versioning:
   272        replacement: CheckMyRoleBindings
   273  
   274  - name: Attestation
   275    actions:
   276    - name: Verify
   277      verb: verify
   278      streamingRequest: true
   279      streamingResponse: true
   280      opResourceInfo:
   281        name: AttestationDomain
   282        requestPaths:
   283          resourceName: [ "ask_for_challenge.attestation_domain" ]
   284      withStoreHandle:
   285        transaction: NONE
   286        readOnly: true