Update

Update modifies the calling user’s personal notification preferences for each channel.

POST /api/v1/settings/notifications/user

Update

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.UserNotificationSettings.Update(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateUserNotificationSettingsResponse != nil {
        // handle response
    }
}

200

{
  "userNotificationSettings": {
    "channelSettings": {
      "email": {
        "accessProvisioned": {
          "enabled": true,
          "locked": true
        },
        "approvalNeeded": {
          "enabled": true,
          "locked": true
        },
        "commentOnRequest": {
          "enabled": true,
          "locked": true
        },
        "completion": {
          "enabled": true,
          "locked": true
        },
        "connectorIssues": {
          "enabled": true,
          "locked": true
        },
        "digest": {
          "dayOfWeek": "WEEKDAY_UNSPECIFIED",
          "enabled": true,
          "frequency": "DIGEST_FREQUENCY_UNSPECIFIED",
          "locked": true
        },
        "enabled": true,
        "expiringAccess": {
          "enabled": true,
          "locked": true
        },
        "provisioningRequest": {
          "enabled": true,
          "locked": true
        },
        "reviews": {
          "enabled": true,
          "locked": true
        },
        "taskReminders": {
          "enabled": true,
          "locked": true
        }
      },
      "slack": {
        "accessProvisioned": {
          "enabled": true,
          "locked": true
        },
        "approvalNeeded": {
          "enabled": true,
          "locked": true
        },
        "commentOnRequest": {
          "enabled": true,
          "locked": true
        },
        "completion": {
          "enabled": true,
          "locked": true
        },
        "connectorIssues": {
          "enabled": true,
          "locked": true
        },
        "digest": {
          "dayOfWeek": "WEEKDAY_UNSPECIFIED",
          "enabled": true,
          "frequency": "DIGEST_FREQUENCY_UNSPECIFIED",
          "locked": true
        },
        "enabled": true,
        "expiringAccess": {
          "enabled": true,
          "locked": true
        },
        "isConfigured": true,
        "provisioningRequest": {
          "enabled": true,
          "locked": true
        },
        "reviews": {
          "enabled": true,
          "locked": true
        },
        "taskReminders": {
          "enabled": true,
          "locked": true
        }
      },
      "teams": {
        "accessProvisioned": {
          "enabled": true,
          "locked": true
        },
        "approvalNeeded": {
          "enabled": true,
          "locked": true
        },
        "commentOnRequest": {
          "enabled": true,
          "locked": true
        },
        "completion": {
          "enabled": true,
          "locked": true
        },
        "connectorIssues": {
          "enabled": true,
          "locked": true
        },
        "digest": {
          "dayOfWeek": "WEEKDAY_UNSPECIFIED",
          "enabled": true,
          "frequency": "DIGEST_FREQUENCY_UNSPECIFIED",
          "locked": true
        },
        "enabled": true,
        "expiringAccess": {
          "enabled": true,
          "locked": true
        },
        "isConfigured": true,
        "provisioningRequest": {
          "enabled": true,
          "locked": true
        },
        "reviews": {
          "enabled": true,
          "locked": true
        },
        "taskReminders": {
          "enabled": true,
          "locked": true
        }
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The UpdateUserNotificationSettingsRequest message.

channelSettings · Channel Settings · object

ChannelSettings groups notification preferences for all supported channels.

Show child attributes

Response

200 - application/json

Successful response

The UpdateUserNotificationSettingsResponse message.

userNotificationSettings · User Notification Settings · object

UserNotificationSettings contains the calling user's personal notification preferences.

Show child attributes