forked from dexorcist/auth0
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
65 lines (45 loc) · 1.61 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
Package auth0 provides a client for using the Auth0 Management API.
Usage
import (
gopkg.in/auth0.v2
gopkg.in/auth0.v2/management
)
Initialize a new client using a domain, client ID and secret.
m, err := management.New(domain, id, secret)
if err != nil {
// handle err
}
With the management client we can now interact with the Auth0 Management API.
c := &management.Client{
Name: auth0.String("Client Name"),
Description: auth0.String("Long description of client"),
}
err = m.Client.Create(c)
if err != nil {
// handle err
}
Authentication
The auth0 package handles authentication by exchanging the client id and secret
supplied when creating a new management client.
This is done using the https://godoc.org/golang.org/x/oauth2 package.
Rate Limiting
The auth0 package also handles rate limiting by respecting the `X-Ratelimit-*`
headers sent by the server.
The amount of time the client waits for the rate limit to be reset is taken from
the `X-Ratelimit-Reset` header as the amount of seconds to wait.
Configuration
There are several other options that can be specified during the creation of a
new client.
m, err := management.New(domain, id, secret,
management.WithDebug(true),
management.WithContext(context.Background()),
management.WithTimeout(5 * time.Seconds))
Request Configuration
As with the global client configuration, fine-grained configuration can be done
on a request basis.
c, err := m.Connection.List(
management.Parameter("strategy", "auth0"),
)
*/
package auth0