mystiq/dex
Archived
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2022-08-17. You can view files and clone it, but cannot push or open issues or pull requests.
dex/schema/workerschema
History
Rubén Soleto Buenvarón 8156870862 add support for resend an invite email 
This change solves the User's API problem when you want to create an user that its email hasn't been verified yet but it exist.
At now, you can resend invitation email using endpoint /users/{id}/resend-invitation

Fixes #184
2016-02-26 09:55:28 +01:00
..
mapper.go *: update all to accommodate changes to go-oidc 2016-01-12 17:16:28 -08:00
README.md add support for resend an invite email 2016-02-26 09:55:28 +01:00
util.go *: move original project to dex 2015-08-18 11:26:57 -07:00
v1-gen.go add support for resend an invite email 2016-02-26 09:55:28 +01:00
v1-json.go add support for resend an invite email 2016-02-26 09:55:28 +01:00
v1.json add support for resend an invite email 2016-02-26 09:55:28 +01:00

README.md

Dex API

The Dex REST API

Version: v1

Models

Client

{
    id: string,
    redirectURIs: [
        string
    ]
}

ClientPage

{
    clients: [
        Client
    ],
    nextPageToken: string
}

ClientWithSecret

{
    id: string,
    redirectURIs: [
        string
    ],
    secret: string
}

Error

{
    error: string,
    error_description: string
}

ResendEmailInvitationRequest

{
    redirectURL: string
}

ResendEmailInvitationResponse

{
    emailSent: boolean,
    resetPasswordLink: string
}

User

{
    admin: boolean,
    createdAt: string,
    disabled: boolean,
    displayName: string,
    email: string,
    emailVerified: boolean,
    id: string
}

UserCreateRequest

{
    redirectURL: string,
    user: User
}

UserCreateResponse

{
    emailSent: boolean,
    resetPasswordLink: string,
    user: User
}

UserDisableRequest

{
    disable: boolean // If true, disable this user, if false, enable them. No error is signaled if the user state doesn't change.
}

UserDisableResponse

{
    ok: boolean
}

UserResponse

{
    user: User
}

UsersResponse

{
    nextPageToken: string,
    users: [
        User
    ]
}

Paths

GET /clients

Summary

List Clients

Description

Retrieve a page of Client objects.

Parameters

Name Located in Description Required Type
nextPageToken query No string

Responses

Code Description Type
200 ClientPage
default Unexpected error

POST /clients

Summary

Create Clients

Description

Register a new Client.

Parameters

Name Located in Description Required Type
body Yes Client

Responses

Code Description Type
200 ClientWithSecret
default Unexpected error

GET /users

Summary

List Users

Description

Retrieve a page of User objects.

Parameters

Name Located in Description Required Type
nextPageToken query No string
maxResults query No integer

Responses

Code Description Type
200 UsersResponse
default Unexpected error

POST /users

Summary

Create Users

Description

Create a new User.

Parameters

Name Located in Description Required Type
body Yes UserCreateRequest

Responses

Code Description Type
200 UserCreateResponse
default Unexpected error

GET /users/{id}

Summary

Get Users

Description

Get a single User object by id.

Parameters

Name Located in Description Required Type
id path Yes string

Responses

Code Description Type
200 UserResponse
default Unexpected error

POST /users/{id}/disable

Summary

Disable Users

Description

Enable or disable a user.

Parameters

Name Located in Description Required Type
id path Yes string
body Yes UserDisableRequest

Responses

Code Description Type
200 UserDisableResponse
default Unexpected error

POST /users/{id}/resend-invitation

Summary

ResendEmailInvitation Users

Description

Resend invitation email to an existing user with unverified email.

Parameters

Name Located in Description Required Type
id path Yes string
body Yes ResendEmailInvitationRequest

Responses

Code Description Type
200 ResendEmailInvitationResponse
default Unexpected error