Update

Update

client.Apps.AppUsers.Update(ctx, appUserID, params) (*AppUserViewC1APIAppV1AppUserViewExpandedarrayAppAppUserUpdateResponse, error)

post/api/v1/apps/{app_user_app_id}/app_users/{app_user_id}

Update an app user by ID. Only the fields specified in the update mask are updated. Currently, only the appUserType, and identityUserId fields can be updated.

Parameters

appUserIDstring

A unique idenditfier of the application user.

paramsAppUserAppIDfieldAppUserfieldExpandMaskfieldUpdateMaskfieldAppAppUserUpdateParams

Hide ParametersShow Parameters

AppUserAppIDfield

param.Field[string]

Path param: The ID of the application.

AppUserfield

optional

param.Field[IDstringAppIDstringAppUserTypeC1APIAppV1AppUserAppUserTypeCreatedAtTimeDeletedAtTimeDisplayNamestringEmailstringEmailsarrayEmployeeIDsarrayIdentityUserIDstringIsExternalboolProfilemapStatusC1APIAppV1AppUserStatusUpdatedAtTimeUsernamestringUsernamesarrayC1APIAppV1AppUser]

Body param: Application User that represents an account in the application.

ExpandMaskfield

optional

param.Field[PathsarrayC1APIAppV1AppUserExpandMask]

Body param: The AppUserExpandMask message contains a list of paths to expand in the response.

UpdateMaskfield

optional

param.Field[string]

Body param:

Returns

AppAppUserUpdateResponsestruct

The AppUserServiceUpdateResponse message.

Hide ParametersShow Parameters

AppUserViewAppPathstringAppUserC1APIAppV1AppUserIdentityUserPathstringLastUsagePathstringC1APIAppV1AppUserView

optional

The AppUserView contains an app user as well as paths for apps, identity users, and last usage in expanded arrays.

Expandedarray

optional

[]AppAppUserUpdateResponseExpanded

The expanded field.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  appUser, err := client.Apps.AppUsers.Update(
    context.TODO(),
    "app_user_id",
    conductoronesdk.AppAppUserUpdateParams{
      AppUserAppID: "app_user_app_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", appUser.AppUserView)
}

200 Example

{
  "appUserView": {
    "appPath": "appPath",
    "appUser": {
      "appUserType": "APP_USER_TYPE_UNSPECIFIED",
      "status": {}
    },
    "identityUserPath": "identityUserPath",
    "lastUsagePath": "lastUsagePath"
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}