API changes for GA release

[chlowell]

API changes since v0.8.0

Upgrading from v0.8.* may require code changes as described below.

confidential.New requires an authority #394

confidential.WithAuthority has been deleted, and the URL it set is now a parameter of confidential.New :

// before
client, err := confidential.New(clientID, cred, confidential.WithAuthority(authority))

// after
client, err := confidential.New(authority, clientID, cred)

confidential.NewCredFromCertChain replaces NewCredFromCert #391

If your application calls NewCredFromCert, update arguments and return values:

before

certs, key, err := confidential.CertFromPEM(certData, password)
if err != nil {
    // TODO: handle error
}
cred := confidential.NewCredFromCert(certs[0], key)

after

certs, key, err := confidential.CertFromPEM(certData, password)
if err != nil {
    // TODO: handle error
}
cred, err := confidential.NewCredFromCert(certs, key)
if err != nil {
    // TODO: handle error
}

If your application calls confidential.NewCredFromCertChain, call NewCredFromCert instead.

All methods accessing cache data have a Context parameter #378

For example, RemoveAccount and Accounts:

// before
accounts, err := client.Accounts()

// after
accounts, err := client.Accounts(context.TODO())

Renamed functions

These functions are renamed but otherwise unchanged:

• confidential.NewCredFromCertChain -> NewCredFromCert #391
• confidential.WithAccessor -> WithCache #386
• public/Client.CreateAuthCodeURL -> AuthCodeURL #384

Deleted API

• confidential.NewCredFromAssertion. This function was deprecated in v0.6.0; use confidential.NewCredFromAssertionCallback instead #385
• Unused options types such as public.InteractiveAuthOption and confidential.AcquireTokenSilentOptions. #383, #390
• confidential/Client.UserID. The value was always "" and never used by the client. #389

New cache.ExportReplace parameters

The interface for custom cache implementations has new parameters for Context and metadata (#378, #395).

[grantjoy]

This is really misleading as it's not mentioned in the docs but this new format must be used for it to work. All the examples I could find were incorrect.

[bgavrilMS]

Well, we GA-ed so I guess this can be closed.