Reporting Services

<back to all web services

Authenticate

auth

Sign In

The following routes are available for this service:
OPTIONS,GET,POST,DELETE/auth
OPTIONS,GET,POST,DELETE/auth/{provider}

// @DataContract
export class AuthenticateResponse implements IMeta, IHasSessionId, IHasBearerToken
{
    // @DataMember(Order=1)
    public UserId?: string;

    // @DataMember(Order=2)
    public SessionId?: string;

    // @DataMember(Order=3)
    public UserName?: string;

    // @DataMember(Order=4)
    public DisplayName?: string;

    // @DataMember(Order=5)
    public ReferrerUrl?: string;

    // @DataMember(Order=6)
    public BearerToken?: string;

    // @DataMember(Order=7)
    public RefreshToken?: string;

    // @DataMember(Order=8)
    public ProfileUrl?: string;

    // @DataMember(Order=9)
    public Roles?: string[];

    // @DataMember(Order=10)
    public Permissions?: string[];

    // @DataMember(Order=11)
    public ResponseStatus?: ResponseStatus;

    // @DataMember(Order=12)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<AuthenticateResponse>) { (Object as any).assign(this, init); }
}

/**
* Sign In
*/
// @Api(Description="Sign In")
// @DataContract
export class Authenticate implements IPost, IMeta
{
    /**
    * AuthProvider, e.g. credentials
    */
    // @DataMember(Order=1)
    public provider?: string;

    // @DataMember(Order=2)
    public State?: string;

    // @DataMember(Order=3)
    public oauth_token?: string;

    // @DataMember(Order=4)
    public oauth_verifier?: string;

    // @DataMember(Order=5)
    public UserName?: string;

    // @DataMember(Order=6)
    public Password?: string;

    // @DataMember(Order=7)
    public RememberMe?: boolean;

    // @DataMember(Order=9)
    public ErrorView?: string;

    // @DataMember(Order=10)
    public nonce?: string;

    // @DataMember(Order=11)
    public uri?: string;

    // @DataMember(Order=12)
    public response?: string;

    // @DataMember(Order=13)
    public qop?: string;

    // @DataMember(Order=14)
    public nc?: string;

    // @DataMember(Order=15)
    public cnonce?: string;

    // @DataMember(Order=17)
    public AccessToken?: string;

    // @DataMember(Order=18)
    public AccessTokenSecret?: string;

    // @DataMember(Order=19)
    public scope?: string;

    // @DataMember(Order=20)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<Authenticate>) { (Object as any).assign(this, init); }
}

TypeScript Authenticate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth HTTP/1.1 
Host: cip-reporting-staging.chargeitpro.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"provider":"String","State":"String","oauth_token":"String","oauth_verifier":"String","UserName":"String","Password":"String","RememberMe":false,"ErrorView":"String","nonce":"String","uri":"String","response":"String","qop":"String","nc":"String","cnonce":"String","AccessToken":"String","AccessTokenSecret":"String","scope":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserId":"String","SessionId":"String","UserName":"String","DisplayName":"String","ReferrerUrl":"String","BearerToken":"String","RefreshToken":"String","ProfileUrl":"String","Roles":["String"],"Permissions":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Meta":{"String":"String"}}