diff --git a/DESCRIPTION b/DESCRIPTION index 88c906ae..eea23ca4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -67,7 +67,7 @@ Language: en-US RoxygenNote: 7.3.2 Roxygen: list(markdown = TRUE) Config/testthat/edition: 3 -Collate: +Collate: 'audits.R' 'browse.R' 'connect.R' diff --git a/NEWS.md b/NEWS.md index 73c12987..72467ba7 100644 --- a/NEWS.md +++ b/NEWS.md @@ -15,6 +15,11 @@ - New `lock_content()` and `unlock_content()` functions for locking and unlocking content items. (#453) +## Enhancements and fixes + +- `get_content()` documentation and type parsing updated to include all + fields returned by the API. (#461) + # connectapi 0.8.0 ## Breaking changes diff --git a/R/get.R b/R/get.R index 01e41f06..ebf1e7c6 100644 --- a/R/get.R +++ b/R/get.R @@ -102,6 +102,9 @@ get_users <- function( #' indicates that all Posit Connect accounts may view the content. The #' `acl` value lets specifically enumerated users and groups view the #' content. Users configured as collaborators may always view content. +#' * `locked`: Whether or not the content is locked. +#' * `locked_message`: A custom message that is displayed by the content +#' item when locked. It is possible to format this message using Markdown. #' * `connection_timeout`: Maximum number of seconds allowed without data #' sent or received across a client connection. A value of 0 means #' connections will never time-out (not recommended). When null, the @@ -137,6 +140,47 @@ get_users <- function( #' * `load_factor`: Controls how aggressively new processes are spawned. #' When null, the default `Scheduler.LoadFactor` is used. Applies only to #' content types that are executed on demand. +#' * `memory_request`: The minimum amount of RAM this content needs when +#' executing or rendering, expressed in bytes. When null, the default +#' `Scheduler.MemoryRequest` is used. Used for off-host execution. +#' * `memory_limit`: The maximum amount of RAM this content will be allowed +#' to consume when executing or rendering, expressed in bytes. If the +#' process tries to use more memory than allowed, it will be terminated. +#' When null, the default `Scheduler.MemoryLimit` is used. Used for +#' off-host execution. +#' * `cpu_request`: The minimum amount of compute power this content needs +#' when executing or rendering, expressed in CPU Units, where 1.0 unit is +#' equivalent to 1 physical or virtual core. Fractional values are allowed. +#' When null, the default `Scheduler.CPURequest` is used. Used for off-host +#' execution. +#' * `cpu_limit`: The maximum amount of compute power this content will be +#' allowed to consume when executing or rendering, expressed in CPU Units. +#' If the process tries to use more CPU than allowed, it will be throttled. +#' When null, the default `Scheduler.CPULimit` is used. Used for off-host +#' execution. +#' * `amd_gpu_limit`: The number of AMD GPUs that will be allocated by +#' Kubernetes to run this content. When null, the default +#' `Scheduler.AMDGPULimit` is used. Used for off-host execution. +#' * `nvidia_gpu_limit`: The number of NVIDIA GPUs that will be allocated by +#' Kubernetes to run this content. When null, the default +#' `Scheduler.NvidiaGPULimit` is used. Used for off-host execution. +#' * `service_account_name`: The name of the Kubernetes service account that +#' is used to run a particular piece of content. It must adhere to valid +#' Kubernetes service account naming rules. Only administrators and +#' publishers can view this value. Only administrators can set or change +#' this value. +#' * `default_image_name`: The default image that will be used when none is +#' defined by the bundle's manifest. If either environment.identifier or +#' environment.image is specified in the bundle's manifest.json, then the +#' settings in the manifest are used and the content-level default settings +#' will be ignored. A null value is returned when the client does not have +#' sufficient rights to see this information. +#' * `default_environment_guid`: The default execution environment that will +#' be used when none is defined by the bundle's manifest. If either +#' environment.identifier or environment.image is specified in the bundle's +#' manifest.json, then the settings in the manifest are used and the +#' content-level default settings will be ignored. A null value is returned +#' when the client does not have sufficient rights to see this information. #' * `created_time`: The timestamp (RFC3339) indicating when this #' content was created. #' * `last_deployed_time`: The timestamp (RFC3339) indicating when @@ -146,9 +190,10 @@ get_users <- function( #' * `app_mode`: The runtime model for this content. Has a value #' of `unknown` before data is deployed to this item. Automatically assigned #' upon the first successful bundle deployment. Allowed: `api`, -#' `jupyter-static`, `python-api`, `python-bokeh`, `python-dash`, -#' `python-streamlit`, `rmd-shiny`, `rmd-static`, `shiny`, `static`, -#' `tensorflow-saved-model`, `unknown`. +#' `jupyter-static`, `jupyter-voila`, `python-api`, `python-bokeh`, +#' `python-dash`, `python-fastapi`, `python-gradio`, `python-shiny`, +#' `python-streamlit`, `quarto-shiny`, `quarto-static`, `rmd-shiny`, +#' `rmd-static`, `shiny`, `static`, `tensorflow-saved-model`, `unknown`. #' * `content_category`: Describes the specialization of the content #' runtime model. Automatically assigned upon the first successful bundle #' deployment. @@ -156,6 +201,20 @@ get_users <- function( #' allows parameter configuration. Automatically assigned upon the first #' successful bundle deployment. Applies only to content with an app_mode #' of rmd-static. +#' * `environment_guid`: The GUID of the execution environment used to run +#' this content. Content running locally on the same server as Connect will +#' have a null value. A null value is also returned when the client does +#' not have sufficient rights to see this information. +#' * `cluster_name`: The location where this content runs. Content running +#' on the same server as Connect will have either a null value or the +#' string "Local". Gives the name of the cluster when run external to the +#' Connect host. A null value is returned when the client does not have +#' sufficient rights to see this information. +#' * `image_name`: The name of the container image used to run this content +#' in containerized environments such as Kubernetes. Content running +#' locally on the same server as Connect will have either a null value or +#' the string "Local". A null value is returned when the client does not +#' have sufficient rights to see this information. #' * `r_version`: The version of the R interpreter associated #' with this content. The value null represents that an R interpreter is #' not used by this content or that the R package environment has not been @@ -166,25 +225,76 @@ get_users <- function( #' interpreter is not used by this content or that the Python package #' environment has not been successfully restored. Automatically assigned #' upon the successful deployment of a bundle. -#' * `run_as`: The UNIX user that executes this content. -#' When null, the default Applications.RunAs is used. Applies -#' only to executable content types - not static. -#' * `run_as_current_user`: Indicates if this content is allowed -#' to execute as the logged-in user when using PAM authentication. -#' Applies only to executable content types - not static. +#' * `quarto_version`: The version of Quarto associated with this content. +#' A null value represents that Quarto is not used by this content, that +#' the content has not been prepared for execution, or that the client does +#' not have sufficient rights to see this information. Automatically +#' assigned upon the successful deployment of a bundle. +#' * `r_environment_management`: Indicates whether or not Connect is +#' managing an R environment and has installed the required packages for +#' this content. A null value represents that R is not used by this content, +#' that the content has not been prepared for execution, or that the client +#' does not have sufficient rights to see this information. Automatically +#' assigned upon the successful deployment of a bundle. +#' * `default_r_environment_management`: Indicates whether or not Connect +#' should create and manage an R environment (installing required packages) +#' for this content. When null, Connect makes this determination based on +#' the server configuration. A null value is also returned when the client +#' does not have sufficient rights to see this information. This value is +#' ignored if the server setting +#' Applications.DefaultEnvironmentManagementSelection is disabled. +#' * `py_environment_management`: Indicates whether or not Connect is +#' managing a Python environment and has installed the required packages +#' for this content. A null value represents that Python is not used by +#' this content, that the content has not been prepared for execution, or +#' that the client does not have sufficient rights to see this information. +#' Automatically assigned upon the successful deployment of a bundle. +#' * `default_py_environment_management`: Indicates whether or not Connect +#' should create and manage a Python environment (installing required +#' packages) for this content. When null, Connect makes this determination +#' based on the server configuration. A null value is also returned when +#' the client does not have sufficient rights to see this information. +#' This value is ignored if the server setting +#' Applications.DefaultEnvironmentManagementSelection is disabled. +#' * `run_as`: The UNIX user that executes this content. When null, the +#' default Applications.RunAs is used. Applies only to executable content +#' types - not static. Only administrators can change this value. If +#' Applications.RunAsEnabled = false, this value will be ignored when +#' executing content. +#' * `run_as_current_user`: Indicates that Connect should run processes for +#' this content item under the Unix account of the user who visits it. +#' Content accessed anonymously will continue to run as the specified +#' run_as user. Connect must be configured to use PAM authentication with +#' the server settings Applications.RunAsCurrentUser = true and +#' PAM.ForwardPassword = true. This setting has no effect for other +#' authentication types. This setting only applies to application content +#' types (Shiny, Dash, Streamlit, and Bokeh). Only administrators can +#' change this value. #' * `owner_guid`: The unique identifier for the owner #' * `content_url`: The URL associated with this content. Computed #' from the GUID for this content. #' * `dashboard_url`: The URL within the Connect dashboard where #' this content can be configured. Computed from the GUID for this content. -#' * `role`: The relationship of the accessing user to this +#' * `vanity_url`: The vanity URL associated with this content item. +#' * `app_role`: The relationship of the accessing user to this #' content. A value of owner is returned for the content owner. editor #' indicates a collaborator. The viewer value is given to users who are #' permitted to view the content. A none role is returned for #' administrators who cannot view the content but are permitted to view #' its configuration. Computed at the time of the request. -#' * `vanity_url`: The vanity URL associated with this content item. #' * `id`: The internal numeric identifier of this content item. +#' * `owner`: Basic details about the owner of this content item. Each entry +#' is a list with the following fields: +#' * `guid`: The user's GUID, or unique identifier, in UUID RFC4122 format. +#' * `username`: The user's username. +#' * `first_name`: The user's first name. +#' * `last_name`: The user's last name. +#' * `public_content_status`: Validation status of public interactive content. +#' When validation is required by licensing, this will be one of "ok", +#' "warning", or "restricted". If licensing does not require validation, it +#' will be "unrestricted"; if licensing does not allow public interactive +#' content, it will be "unlicensed". If the app has not been made public, +#' but public content is permitted, it will be "none". #' * `tags`: Tags associated with this content item. Each entry is a list #' with the following fields: #' * `id`: The identifier for the tag. @@ -195,12 +305,6 @@ get_users <- function( #' created. #' * `updated_time`: The timestamp (RFC3339) indicating when the tag was #' last updated. -#' * `owner`: Basic details about the owner of this content item. Each entry -#' is a list with the following fields: -#' * `guid`: The user's GUID, or unique identifier, in UUID RFC4122 format. -#' * `username`: The user's username. -#' * `first_name`: The user's first name. -#' * `last_name`: The user's last name. #' #' @details #' Please see https://docs.posit.co/connect/api/#get-/v1/content for more diff --git a/R/ptype.R b/R/ptype.R index 3600266a..7e2ad0e4 100644 --- a/R/ptype.R +++ b/R/ptype.R @@ -51,6 +51,8 @@ connectapi_ptypes <- list( "title" = NA_character_, "description" = NA_character_, "access_type" = NA_character_, + "locked" = FALSE, + "locked_message" = NA_character_, "connection_timeout" = NA_integer_, "read_timeout" = NA_integer_, "init_timeout" = NA_integer_, @@ -59,12 +61,22 @@ connectapi_ptypes <- list( "min_processes" = NA_integer_, "max_conns_per_process" = NA_integer_, "load_factor" = NA_real_, + "memory_request" = NA_integer_, + "memory_limit" = NA_real_, + "cpu_request" = NA_real_, + "cpu_limit" = NA_real_, + "amd_gpu_limit" = NA_real_, + "nvidia_gpu_limit" = NA_real_, + "service_account_name" = NA_character_, + "default_image_name" = NA_character_, + "default_environment_guid" = NA_character_, "created_time" = NA_datetime_, "last_deployed_time" = NA_datetime_, "bundle_id" = NA_character_, "app_mode" = NA_character_, "content_category" = NA_character_, "parameterized" = FALSE, + "environment_guid" = NA_character_, "cluster_name" = NA_character_, "image_name" = NA_character_, "r_version" = NA_character_, @@ -75,10 +87,11 @@ connectapi_ptypes <- list( "owner_guid" = NA_character_, "content_url" = NA_character_, "dashboard_url" = NA_character_, - "app_role" = NA_character_, "vanity_url" = NA_character_, + "app_role" = NA_character_, "id" = NA_character_, "owner" = NA_list_, + "public_content_status" = NA_character_, "tags" = NA_list_, ), content_old = tibble::tibble( diff --git a/man/VariantR6.Rd b/man/VariantR6.Rd index be0cc4a6..cdf922d6 100644 --- a/man/VariantR6.Rd +++ b/man/VariantR6.Rd @@ -39,7 +39,6 @@ Other R6 classes: \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-Variant-get_variant}{\code{Variant$get_variant()}} \item \href{#method-Variant-get_variant_remote}{\code{Variant$get_variant_remote()}} \item \href{#method-Variant-new}{\code{Variant$new()}} \item \href{#method-Variant-send_mail}{\code{Variant$send_mail()}} @@ -90,19 +89,12 @@ Other R6 classes: }} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-Variant-get_variant}{}}} -\subsection{Method \code{get_variant()}}{ -Get the underlying variant data. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{Variant$get_variant()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-Variant-get_variant_remote}{}}} \subsection{Method \code{get_variant_remote()}}{ +Get the underlying variant data. + + Get and store the (remote) variant data. \subsection{Usage}{ \if{html}{\out{
}}\preformatted{Variant$get_variant_remote()}\if{html}{\out{
}} diff --git a/man/VariantSchedule.Rd b/man/VariantSchedule.Rd index ee961e1a..d7c23e29 100644 --- a/man/VariantSchedule.Rd +++ b/man/VariantSchedule.Rd @@ -81,7 +81,6 @@ Other R6 classes:
  • connectapi::Variant$get_subscribers()
  • connectapi::Variant$get_url()
  • connectapi::Variant$get_url_rev()
    • -
  • connectapi::Variant$get_variant()
  • connectapi::Variant$get_variant_remote()
  • connectapi::Variant$job()
  • connectapi::Variant$jobs()
    • diff --git a/man/VariantTask.Rd b/man/VariantTask.Rd index 4f23bd9e..316a53a1 100644 --- a/man/VariantTask.Rd +++ b/man/VariantTask.Rd @@ -80,7 +80,6 @@ Other R6 classes:
  • connectapi::Variant$get_subscribers()
  • connectapi::Variant$get_url()
  • connectapi::Variant$get_url_rev()
    • -
  • connectapi::Variant$get_variant()
  • connectapi::Variant$get_variant_remote()
  • connectapi::Variant$job()
  • connectapi::Variant$jobs()
    • diff --git a/man/get_content.Rd b/man/get_content.Rd index 833bcd9c..92e4a33e 100644 --- a/man/get_content.Rd +++ b/man/get_content.Rd @@ -35,6 +35,9 @@ Connect will be able to view this content. The value \code{logged_in} indicates that all Posit Connect accounts may view the content. The \code{acl} value lets specifically enumerated users and groups view the content. Users configured as collaborators may always view content. +\item \code{locked}: Whether or not the content is locked. +\item \code{locked_message}: A custom message that is displayed by the content +item when locked. It is possible to format this message using Markdown. \item \code{connection_timeout}: Maximum number of seconds allowed without data sent or received across a client connection. A value of 0 means connections will never time-out (not recommended). When null, the @@ -70,6 +73,47 @@ only to content types that are executed on demand. \item \code{load_factor}: Controls how aggressively new processes are spawned. When null, the default \code{Scheduler.LoadFactor} is used. Applies only to content types that are executed on demand. +\item \code{memory_request}: The minimum amount of RAM this content needs when +executing or rendering, expressed in bytes. When null, the default +\code{Scheduler.MemoryRequest} is used. Used for off-host execution. +\item \code{memory_limit}: The maximum amount of RAM this content will be allowed +to consume when executing or rendering, expressed in bytes. If the +process tries to use more memory than allowed, it will be terminated. +When null, the default \code{Scheduler.MemoryLimit} is used. Used for +off-host execution. +\item \code{cpu_request}: The minimum amount of compute power this content needs +when executing or rendering, expressed in CPU Units, where 1.0 unit is +equivalent to 1 physical or virtual core. Fractional values are allowed. +When null, the default \code{Scheduler.CPURequest} is used. Used for off-host +execution. +\item \code{cpu_limit}: The maximum amount of compute power this content will be +allowed to consume when executing or rendering, expressed in CPU Units. +If the process tries to use more CPU than allowed, it will be throttled. +When null, the default \code{Scheduler.CPULimit} is used. Used for off-host +execution. +\item \code{amd_gpu_limit}: The number of AMD GPUs that will be allocated by +Kubernetes to run this content. When null, the default +\code{Scheduler.AMDGPULimit} is used. Used for off-host execution. +\item \code{nvidia_gpu_limit}: The number of NVIDIA GPUs that will be allocated by +Kubernetes to run this content. When null, the default +\code{Scheduler.NvidiaGPULimit} is used. Used for off-host execution. +\item \code{service_account_name}: The name of the Kubernetes service account that +is used to run a particular piece of content. It must adhere to valid +Kubernetes service account naming rules. Only administrators and +publishers can view this value. Only administrators can set or change +this value. +\item \code{default_image_name}: The default image that will be used when none is +defined by the bundle's manifest. If either environment.identifier or +environment.image is specified in the bundle's manifest.json, then the +settings in the manifest are used and the content-level default settings +will be ignored. A null value is returned when the client does not have +sufficient rights to see this information. +\item \code{default_environment_guid}: The default execution environment that will +be used when none is defined by the bundle's manifest. If either +environment.identifier or environment.image is specified in the bundle's +manifest.json, then the settings in the manifest are used and the +content-level default settings will be ignored. A null value is returned +when the client does not have sufficient rights to see this information. \item \code{created_time}: The timestamp (RFC3339) indicating when this content was created. \item \code{last_deployed_time}: The timestamp (RFC3339) indicating when @@ -79,9 +123,10 @@ Automatically assigned upon the successful deployment of that bundle. \item \code{app_mode}: The runtime model for this content. Has a value of \code{unknown} before data is deployed to this item. Automatically assigned upon the first successful bundle deployment. Allowed: \code{api}, -\code{jupyter-static}, \code{python-api}, \code{python-bokeh}, \code{python-dash}, -\code{python-streamlit}, \code{rmd-shiny}, \code{rmd-static}, \code{shiny}, \code{static}, -\code{tensorflow-saved-model}, \code{unknown}. +\code{jupyter-static}, \code{jupyter-voila}, \code{python-api}, \code{python-bokeh}, +\code{python-dash}, \code{python-fastapi}, \code{python-gradio}, \code{python-shiny}, +\code{python-streamlit}, \code{quarto-shiny}, \code{quarto-static}, \code{rmd-shiny}, +\code{rmd-static}, \code{shiny}, \code{static}, \code{tensorflow-saved-model}, \code{unknown}. \item \code{content_category}: Describes the specialization of the content runtime model. Automatically assigned upon the first successful bundle deployment. @@ -89,6 +134,20 @@ deployment. allows parameter configuration. Automatically assigned upon the first successful bundle deployment. Applies only to content with an app_mode of rmd-static. +\item \code{environment_guid}: The GUID of the execution environment used to run +this content. Content running locally on the same server as Connect will +have a null value. A null value is also returned when the client does +not have sufficient rights to see this information. +\item \code{cluster_name}: The location where this content runs. Content running +on the same server as Connect will have either a null value or the +string "Local". Gives the name of the cluster when run external to the +Connect host. A null value is returned when the client does not have +sufficient rights to see this information. +\item \code{image_name}: The name of the container image used to run this content +in containerized environments such as Kubernetes. Content running +locally on the same server as Connect will have either a null value or +the string "Local". A null value is returned when the client does not +have sufficient rights to see this information. \item \code{r_version}: The version of the R interpreter associated with this content. The value null represents that an R interpreter is not used by this content or that the R package environment has not been @@ -99,25 +158,78 @@ associated with this content. The value null represents that a Python interpreter is not used by this content or that the Python package environment has not been successfully restored. Automatically assigned upon the successful deployment of a bundle. -\item \code{run_as}: The UNIX user that executes this content. -When null, the default Applications.RunAs is used. Applies -only to executable content types - not static. -\item \code{run_as_current_user}: Indicates if this content is allowed -to execute as the logged-in user when using PAM authentication. -Applies only to executable content types - not static. +\item \code{quarto_version}: The version of Quarto associated with this content. +A null value represents that Quarto is not used by this content, that +the content has not been prepared for execution, or that the client does +not have sufficient rights to see this information. Automatically +assigned upon the successful deployment of a bundle. +\item \code{r_environment_management}: Indicates whether or not Connect is +managing an R environment and has installed the required packages for +this content. A null value represents that R is not used by this content, +that the content has not been prepared for execution, or that the client +does not have sufficient rights to see this information. Automatically +assigned upon the successful deployment of a bundle. +\item \code{default_r_environment_management}: Indicates whether or not Connect +should create and manage an R environment (installing required packages) +for this content. When null, Connect makes this determination based on +the server configuration. A null value is also returned when the client +does not have sufficient rights to see this information. This value is +ignored if the server setting +Applications.DefaultEnvironmentManagementSelection is disabled. +\item \code{py_environment_management}: Indicates whether or not Connect is +managing a Python environment and has installed the required packages +for this content. A null value represents that Python is not used by +this content, that the content has not been prepared for execution, or +that the client does not have sufficient rights to see this information. +Automatically assigned upon the successful deployment of a bundle. +\item \code{default_py_environment_management}: Indicates whether or not Connect +should create and manage a Python environment (installing required +packages) for this content. When null, Connect makes this determination +based on the server configuration. A null value is also returned when +the client does not have sufficient rights to see this information. +This value is ignored if the server setting +Applications.DefaultEnvironmentManagementSelection is disabled. +\item \code{run_as}: The UNIX user that executes this content. When null, the +default Applications.RunAs is used. Applies only to executable content +types - not static. Only administrators can change this value. If +Applications.RunAsEnabled = false, this value will be ignored when +executing content. +\item \code{run_as_current_user}: Indicates that Connect should run processes for +this content item under the Unix account of the user who visits it. +Content accessed anonymously will continue to run as the specified +run_as user. Connect must be configured to use PAM authentication with +the server settings Applications.RunAsCurrentUser = true and +PAM.ForwardPassword = true. This setting has no effect for other +authentication types. This setting only applies to application content +types (Shiny, Dash, Streamlit, and Bokeh). Only administrators can +change this value. \item \code{owner_guid}: The unique identifier for the owner \item \code{content_url}: The URL associated with this content. Computed from the GUID for this content. \item \code{dashboard_url}: The URL within the Connect dashboard where this content can be configured. Computed from the GUID for this content. -\item \code{role}: The relationship of the accessing user to this +\item \code{vanity_url}: The vanity URL associated with this content item. +\item \code{app_role}: The relationship of the accessing user to this content. A value of owner is returned for the content owner. editor indicates a collaborator. The viewer value is given to users who are permitted to view the content. A none role is returned for administrators who cannot view the content but are permitted to view its configuration. Computed at the time of the request. -\item \code{vanity_url}: The vanity URL associated with this content item. \item \code{id}: The internal numeric identifier of this content item. +\item \code{owner}: Basic details about the owner of this content item. Each entry +is a list with the following fields: +\itemize{ +\item \code{guid}: The user's GUID, or unique identifier, in UUID RFC4122 format. +\item \code{username}: The user's username. +\item \code{first_name}: The user's first name. +\item \code{last_name}: The user's last name. +} +\item \code{public_content_status}: Validation status of public interactive content. +When validation is required by licensing, this will be one of "ok", +"warning", or "restricted". If licensing does not require validation, it +will be "unrestricted"; if licensing does not allow public interactive +content, it will be "unlicensed". If the app has not been made public, +but public content is permitted, it will be "none". \item \code{tags}: Tags associated with this content item. Each entry is a list with the following fields: \itemize{ @@ -130,14 +242,6 @@ created. \item \code{updated_time}: The timestamp (RFC3339) indicating when the tag was last updated. } -\item \code{owner}: Basic details about the owner of this content item. Each entry -is a list with the following fields: -\itemize{ -\item \code{guid}: The user's GUID, or unique identifier, in UUID RFC4122 format. -\item \code{username}: The user's username. -\item \code{first_name}: The user's first name. -\item \code{last_name}: The user's last name. -} } } \description{