Package animeshon.identity.v1alpha1
Index
Identity
GetUserProfile |
---|
rpc GetUserProfile(GetUserProfileRequest) UserProfile |
GetUser |
---|
rpc GetUser(GetUserRequest) User |
ListUsers |
---|
rpc ListUsers(ListUsersRequest) ListUsersResponse |
CreateUser |
---|
rpc CreateUser(CreateUserRequest) User |
UpdateUser |
---|
rpc UpdateUser(UpdateUserRequest) User |
DeleteUser |
---|
rpc DeleteUser(DeleteUserRequest) .google.protobuf.Empty |
GetUserSettings |
---|
rpc GetUserSettings(GetUserSettingsRequest) UserSettings |
UpdateUserSettings |
---|
rpc UpdateUserSettings(UpdateUserSettingsRequest) UserSettings |
GetUserNotifications |
---|
rpc GetUserNotifications(GetUserNotificationsRequest) UserNotifications |
UpdateUserNotifications |
---|
rpc UpdateUserNotifications(UpdateUserNotificationsRequest) UserNotifications |
GetUserDefaults |
---|
rpc GetUserDefaults(GetUserDefaultsRequest) UserDefaults |
GetGroup |
---|
rpc GetGroup(GetGroupRequest) Group |
ListGroups |
---|
rpc ListGroups(ListGroupsRequest) ListGroupsResponse |
CreateGroup |
---|
rpc CreateGroup(CreateGroupRequest) Group |
UpdateGroup |
---|
rpc UpdateGroup(UpdateGroupRequest) Group |
DeleteGroup |
---|
rpc DeleteGroup(DeleteGroupRequest) .google.protobuf.Empty |
CreateGroupRequest
Field | Description |
---|---|
group | Group The group to create. |
CreateUserRequest
Field | Description |
---|---|
user | User The user to create. |
DeleteGroupRequest
Field | Description |
---|---|
name | string The name of the group to delete. |
DeleteUserRequest
Field | Description |
---|---|
name | string The name of the user to delete. |
GetGroupRequest
Field | Description |
---|---|
name | string The name of the group to retrieve. |
GetUserDefaultsRequest
Field | Description |
---|---|
name | string The name of the user to retrieve the defaults from. |
GetUserNotificationsRequest
Field | Description |
---|---|
name | string The name of the user to retrieve the notifications from. |
GetUserProfileRequest
Field | Description |
---|---|
name | string The name of the user to retrieve the profile from. |
GetUserRequest
Field | Description |
---|---|
name | string The name of the user to retrieve. |
GetUserSettingsRequest
Field | Description |
---|---|
name | string The name of the user to retrieve the settings from. |
Group
Field | Description |
---|---|
name | string The resource name of the group. |
members | repeated string The list of members of the group. Groups might include other groups. |
etag | bytes An etag for concurrency control, ignored during creation. |
ListGroupsRequest
Field | Description |
---|---|
page_size | int32 If unspecified, server will pick an appropriate default. |
page_token | string The value returned from the previous call. |
filter | string A filter to be applied to results. |
ListGroupsResponse
Field | Description |
---|---|
groups | repeated Group The list of groups. |
next_page_token | string A token to retrieve next page of results. |
ListUsersRequest
Field | Description |
---|---|
page_size | int32 If unspecified, server will pick an appropriate default. |
page_token | string The value returned from the previous call. |
filter | string A filter to be applied to results. |
ListUsersResponse
Field | Description |
---|---|
users | repeated User The list of users. |
next_page_token | string A token to retrieve next page of results. |
UpdateGroupRequest
Field | Description |
---|---|
group | Group The group to update. |
update_mask | google.protobuf.FieldMask The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated. |
UpdateUserNotificationsRequest
Field | Description |
---|---|
notifications | UserNotifications The user notifications to update. |
update_mask | google.protobuf.FieldMask The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated. |
UpdateUserRequest
Field | Description |
---|---|
user | User The user to update. |
update_mask | google.protobuf.FieldMask The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated. |
UpdateUserSettingsRequest
Field | Description |
---|---|
settings | UserSettings The user settings to update. |
update_mask | google.protobuf.FieldMask The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated. |
User
Field | Description |
---|---|
name | string The resource name of the user. |
uuid | string The uuid that identifies the user during the authentication flow. |
username | string The public username of the user. |
discriminator | string The public discriminator of the user. |
primary_email | string The primary email address of the user. |
primary_email_verified | bool Whether the primary email address has been verified. |
given_name | string The given name of the user. |
family_name | string The family name of the user. |
display_name | string The name of the user. |
country_code | string The country where the user is located at, must be a valid ISO-3166 code. |
locale | string The locale preferred by the user, must be a valid BCP-47 code. |
locale_fallback | string The fallback locale preferred by the user, must be a valid BCP-47 code. The only allowed values are eng, jpn, and jpn-Latn (romaji). |
birthday | google.type.Date The birthday defined by the user, this value is used to determine whether the user should be allowed to access explicit and sensitive content. |
gender | Gender The gender of the user. |
profile_image | string The profile image of the user. |
banner_image | string The banner image of the user. |
UserDefaults
Field | Description |
---|---|
album_profile | string The system-managed album dedicated to user profile images. |
album_banner | string The system-managed album dedicated to user banner images. |
playlist_liked | string The system-managed playlist dedicated to user liked content. |
playlist_later | string The system-managed playlist dedicated to user saved for later content. |
UserNotifications
Field | Description |
---|---|
name | string The resource name of the user. |
UserProfile
This message is returned only when a user wants to fetch information about another user and the amount of information returned is greatly reduced to ensure that personal and confidential information is never disclosed by accident to other users. The user profile is read-only.
Field | Description |
---|---|
name | string The resource name of the user. |
profile_image | string The profile image of the user. |
banner_image | string The banner image of the user. |
username | string The public username of the user. |
discriminator | string The public discriminator of the user. |
birthday | google.type.Date The birthday of the user, this value is hidden for private profiles. |
gender | Gender The gender of the user, this value is hidden for private profiles. |
UserSettings
Field | Description |
---|---|
name | string The resource name of the user. |
profile_visibility | UserSettings.Visibility A private user will only have the username, discriminator, profile image and banner image public. |
show_explicit_content | bool Whether the user choose to see explicit content during navigation. |
enable_developer_mode | bool Whether the user has enabled the developer mode. |
Gender
Name | Description |
---|---|
GENDER_UNSPECIFIED | Not specified. |
MALE | Male. |
FEMALE | Female. |
OTHER | Any other non-binary gender. |
UserSettings.Visibility
Name | Description |
---|---|
VISIBILITY_UNSPECIFIED | Not specified. |
PUBLIC | Public. |
PRIVATE | Private. |