Create a Join flow

Create a Join Flow. A Flow combines configurations for one or more vendors that may be used to allow system owners to grant authorization for systems they control. Flows are reusable across multiple authorization sessions.

Upon completion of a session for this Flow, a redirect to the given redirectURI will be served. The redirect URI will receive a state query string parameter matching the state parameter that was provided when the session was initiated via the /join/flows/{flowID}/authorize endpoint.

Upon success, the redirect URI will also receive an enrollmentID query string parameter, if the Flow was associated with a Program.

Upon failure, the redirect URI will receive an error query string parameter with an OAuth error code and an optional error_description parameter with a description of the error.

Flows may be deleted, but are immutable after creation.

See the Working with Production Devices guide for more context on usage of this API.

Body Params
string

The Derapi Program ID, if any, to enroll in upon successful authorization via this Flow.

vendors
array of objects
required

A list of the vendors that this Join flow should allow. Each vendor may require references to previously-stored credentials. A given vendor should appear at most once within this list.

vendors*
uri
required

The URI to redirect the system owner to after they have completed an authorization for this flow.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json