package accesscode

Get desktop application:
View/edit binary Protocol Buffers messages

Service definition

• rpc CreateAc (CreateAcRequest, google.protobuf.Empty)

  accesscode.proto:14

  Resource oriented RPCs for AccessCodes:

  message CreateAcRequest

  accesscode.proto:63

  • string ac_name = 1

  • string se_name = 2

  • string se_uid = 3

  • string description = 4

  • repeated string scenarios = 5

  • repeated string courses = 6

  • string expiration = 7

  • bool restricted_bind = 8

  • string restricted_bind_value = 9

  • bool printable = 10

• rpc CreateOtac (CreateOtacRequest, OneTimeAccessCode)

  accesscode.proto:22

  Resource oriented RPCs for OneTimeAccessCodes:

  message CreateOtacRequest

  accesscode.proto:57

  • string se_name = 1

  • string se_uid = 2

  • string max_duration = 3

• rpc DeleteAc (general.ResourceId, google.protobuf.Empty)

  accesscode.proto:17

• rpc DeleteCollectionAc (general.ListOptions, google.protobuf.Empty)

  accesscode.proto:18

• rpc DeleteCollectionOtac (general.ListOptions, google.protobuf.Empty)

  accesscode.proto:26

• rpc DeleteOtac (general.ResourceId, google.protobuf.Empty)

  accesscode.proto:25

• rpc GetAc (general.GetRequest, AccessCode)

  accesscode.proto:15

• rpc GetAcOwnerReferences (general.GetRequest, general.OwnerReferences)

  accesscode.proto:33

• rpc GetAccessCodeWithOTACs (general.ResourceId, AccessCode)

  accesscode.proto:32

• rpc GetAccessCodesWithOTACs (ResourceIds, ListAcsResponse)

  accesscode.proto:31

  message ResourceIds

  accesscode.proto:36

  • repeated string ids = 1

• rpc GetOtac (general.GetRequest, OneTimeAccessCode)

  accesscode.proto:23

• rpc ListAc (general.ListOptions, ListAcsResponse)

  accesscode.proto:19

• rpc ListOtac (general.ListOptions, ListOtacsResponse)

  accesscode.proto:27

  message ListOtacsResponse

  accesscode.proto:53

  • repeated OneTimeAccessCode otacs = 1

• rpc UpdateAc (UpdateAccessCodeRequest, google.protobuf.Empty)

  accesscode.proto:16

  message UpdateAccessCodeRequest

  accesscode.proto:91

  To determine if a boolean value was provided or not for the restricted_bind and printable field, we need to use a wrapper type. Otherwise we can not tell if the value was provided or the default value (false) was set

  • string id = 1

  • string description = 2

  • repeated string scenarios = 3

  • repeated string courses = 4

  • string expiration = 5

  • optional google.protobuf.BoolValue restricted_bind = 6

  • optional google.protobuf.BoolValue printable = 7

• rpc UpdateOtac (OneTimeAccessCode, google.protobuf.Empty)

  accesscode.proto:24

• rpc ValidateExistence (general.ResourceId, ResourceValidation)

  accesscode.proto:30

  Helper functions

  message ResourceValidation

  accesscode.proto:40

  • bool valid = 1

Used as response type in: AccessCodeSvc.GetAc, AccessCodeSvc.GetAccessCodeWithOTACs

Used as field type in: ListAcsResponse

• string id = 1

• string uid = 2

• string description = 3

• repeated string scenarios = 4

• repeated string courses = 5

• string expiration = 6

• bool restricted_bind = 7

• string restricted_bind_value = 8

• bool printable = 9

• map<string, string> labels = 10

• string user_id = 1

• string course_or_scenario_id = 2

Used as response type in: AccessCodeSvc.GetAccessCodesWithOTACs, AccessCodeSvc.ListAc

• repeated AccessCode access_codes = 1

Used as request type in: AccessCodeSvc.UpdateOtac

Used as response type in: AccessCodeSvc.CreateOtac, AccessCodeSvc.GetOtac

Used as field type in: ListOtacsResponse

• string id = 1

• string uid = 2

• string user = 3

• string redeemed_timestamp = 4

• string max_duration = 5

• map<string, string> labels = 6